.Net XML комментарий в API документации

голоса
15

Есть простой способ создания документации MSDN-стиле с выходом Visual Studio XML?
Я не достаточно терпеливы , чтобы создать хороший для XSLT, потому что я знаю , что я не первый человек , чтобы пересечь этот мост.

Кроме того, я попытался создать Сандкасл в последнее время, но это действительно сделал крест мои глаза. Либо я пропускал что-то важное в процессе или он просто слишком вовлечен.

Я знаю, что кто-то там есть действительно хорошие мертвые простые решения.

Я вновь здесь, потому что я думаю, что мое форматирование сделал этот пункт не-приглашения следующего содержания:

Я дал Сандкасл попробовать, но было очень трудно получить его настроить. То, что я действительно имею в виду что-то гораздо проще.

То есть, если я просто не понимаю SandCastle процесса. Казалось, что ужасно много дополнительного багажа для меня просто, чтобы произвести что-то хорошее для тестеров работать.

Задан 03/08/2008 в 23:03
источник пользователем
На других языках...                            


6 ответов

голоса
9

Вы ищете Sandcastle

Страница проекта: Sandcastle Релизы

Блог: Sandcastle Блог

NDoc Документирование кода Генератор для .NET используется как инструмент выбора, но поддержка все , но остановился.

Ответил 03/08/2008 d 23:12
источник пользователем

голоса
5

Вы должны также использовать Sandcastle Builder файла справки. Он предоставляет вам NDoc как GUI для создания файлов справки, так что вы не должны делать ничего из командной строки.

Добро пожаловать в File Builder проекта Sandcastle Помощь

Ответил 19/09/2008 d 16:22
источник пользователем

голоса
5

Посмотрите на Sandcastle , который делает именно это. Это также один из наиболее простых решений там, и это более или менее инструмент выбора, так и в долгосрочной перспективе, возможно , мы могли бы помочь вам настроить Sandcastle , если вы укажете , какие проблемы вы столкнулись во время установки?

Ответил 03/08/2008 d 23:14
источник пользователем

голоса
3

Следуйте этим простым 5 шагов статьи и вы очень много сделали. В качестве бонуса вы можете использовать H2Viewer для просмотра HTML - справка и 2.x файлов.

Ответил 04/08/2008 d 11:31
источник пользователем

голоса
3

Я просто настроить Sandcastle снова. Попробуйте установить его (выпуск май 2008) и поиск SandcastleGui.exe или что-то подобное (это в примерах папку или так).

Нажмите кнопку Add ассамблеи и добавить Ассамблею или сборки, добавлять XML-файлы документация (те, сгенерированные компилятором, если вы включили эту опцию), а затем построить.

Это займет некоторое время, но результат будет стоить затраченных усилий. Это будет на самом деле искать вещи из MSDN, так что ваш результат документация будет также иметь класс наследование всего путь вниз к System.Object со ссылками на MSDN и прочее.

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

Кроме того , посмотрите на Sandcastle Help File Builder , это несколько более продвинутый графический интерфейс для него.

Ответил 04/08/2008 d 11:27
источник пользователем

голоса
2

Я использую NDoc3

Ответил 21/02/2010 d 23:12
источник пользователем

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more