Sandcastle Создать блок кода

Question

Sandcastle Создать блок кода

У меня есть проект C#, который мне нужен для создания файла документации. Я использую последнюю версию SHFB и VS 2005 для создания файла документации XML.

Как я могу добавить блоки кода внутри документации? Я хочу показать все строки моей функции, а не только одну часть для образца.

Я нашел документ, который описывает, как добавить блок кода в sandcastle с помощью тега code, но у моих функций нет этого тега, также в проекте много функций, поэтому невозможно добавить теги для всех функций.

Есть ли способ автоматически создать тег кода из проекта или плагин для показа внутри функции?

Благодарю.

0

sandcastle shfb

Источник

user588353 03 дек '13 в 13:37

1 ответ

Решение

Другие вопросы по тегам sandcastle shfb

user1302209 13 дек '13 в 02:44 2013-12-13 02:44 · Accepted Answer · 2013-12-13 02:44

Вам нужно будет использовать пользовательские атрибуты источника и региона для элемента в XML-комментариях каждой функции. Невозможно просто импортировать код, основанный на идентификаторе члена API, поэтому, если вы действительно хотите, чтобы весь код из каждого свойства, события, метода и т. Д. В файле справки, вам придется сделать это трудным способом: оберните тело каждого в регионе и добавить элемент к комментариям каждого из них, чтобы импортировать этот регион.

По запросу по электронной почте я публикую это здесь, но учтите, что я не следую Stackru. Если у вас есть вопросы, касающиеся SHFB или Sandcastle, опубликуйте их на странице обсуждения проекта SHFB в CodePlex. Благодарю.

Эрик