Как я могу показать тело метода в Документированной библиотеке классов Sandcastle - PullRequest
Новая
       30

Как я могу показать тело метода в Документированной библиотеке классов Sandcastle

2 голосов
/ 05 октября 2010

Я создал диаграммы классов для своих проектов в Visual Studio 2008 и внедрил эти диаграммы с помощью Sandcastle.

Пример:

* Документированная библиотека классов Sandcastle

Biol .. :: .. f_BiolabTestSayisi Method
Biol Class Смотрите также Отправить отзыв

Biol hastalarının sayısını veren fonksiyon Пространство имен: TR.Biol Сборка: TR (в TR.dll) Версия: 1.0.0.0 (1.0.0.0)

Синтаксис

C # public static DataSet f_BiolTestSayisi ()

Visual Basic

Публичная общая функция f_BiolTestSayisi As DataSet

Visual C ++

общественность: статический DataSet ^ f_BiolTestSayisi ()

Возвращаемое значение [Отсутствует документация для "M: TR.Biol.Biol.f_BioTestSayi"] *

Я могу видеть все классы в моем проекте с помощью документированной библиотеки классов A Sandcastle. Я также хочу увидеть прототип метода и тело . Как я могу получить это?

Заранее спасибо.

Ответы [ 2 ]

1 голос
/ 05 октября 2010

Вам захочется взглянуть на расширение сборки sandcastle с помощью Sandcastle Components (это довольно хорошая статья о проекте кода , хотя и немного устаревшая).С уже созданными вещами я бы предложил использовать компонент кодового блока и разместить область вокруг вашего метода.В противном случае вам, вероятно, придется написать компонент самостоятельно.

Обратите внимание, что документы не извлекаются из фактического кода - комментарии к документам XML извлекаются из кода компилятором, а затем документация создаетсяэтот XML.Это означает, что на самом деле у вас нет кода при сборке документов (и фактических номеров файлов / строк).Расширение компонента блока кода для поиска имени файла / метода может работать, если вы также управляете разрешением перегрузки.

0 голосов
/ 06 октября 2010

Sandcastle генерирует документацию из скомпилированных сборок и XML-файла документа. У него нет доступа к исходному коду. Как уже упоминалось, возможно, это можно сделать с помощью компонента, но вам нужно изменить свои XML-комментарии. Напротив, наш VSdocman использует другой подход. Он принимает комментарии XML и генерирует документацию непосредственно из вашего исходного кода. Таким образом, он может легко включать тело метода в сгенерированную справку. Попробуйте, если не возражаете против коммерческого решения.

...