Каков наилучший способ/инструмент для документирования кода .NET

Ответ 1

GhostDoc (http://www.roland-weigelt.de/ghostdoc/) - хороший инструмент для написания сводных тегов в вашем коде.

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

У меня нет имен с головы, но есть инструменты для вытягивания тегов summery в xml и html. Инструменты создадут для вашего API такой сайт, как MSDN. Это довольно хорошая система, но разработчик (вы) задокументировал вам код.

Ответ 2

Sandbule Help File Builder - полезный интерфейс для Sandcastle. Вы также можете изучить Doxygen.

Ответ 3

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

Ответ 4

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

Одна проблема с Sandcastle заключается в том, что генерация полной документации может быть довольно интенсивной в памяти и обычно занимает больше времени, чем использование NDoc. NDoc теперь прекратил проект, застрявший в .NET 1.0, но вы все равно можете использовать измененный NDoc2 Alpha, который МОЖЕТ обрабатывать сборки и источник .NET 2.0. Однако для более новых версий рамки Sandcastle - это единственный способ пойти.

Однако еще одна хорошая вещь о Sandcastle заключается в том, что его можно также использовать для создания концептуальной документации для ваших проектов с использованием MAML.

Ответ 5

Ghostdoc отлично подходит для быстрого добавления комментариев к вашему коду с наименьшим количеством усилий.

Ответ 6

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

Docu - простая документация, сделанная просто

Ответ 7

Мощная надстройка для Visual Studio - это Документация Atomineer Pro. Он создает/обновляет комментарии к документации в исходном коде аналогично GhostDoc, но гораздо более мощным и настраиваемым.

Он поддерживает широкий диапазон форматов комментариев (Documentation Xml, Doxygen, JavaDoc, Qt и даже может конвертировать устаревшие комментарии) и обрабатывает исходные коды С#, Visual Basic, С++/CLI, С++, C и Java. Стиль и компоновка комментариев очень настраиваются, а также имеется ряд дополнительных помощников, чтобы ускорить процесс кодирования/документирования (встроенные средства ввода, перенос слов, управление пробелами, автоматическое преобразование объектов html и т.д.).

Ответ 8

Вы можете попробовать Live Documenter.

Позволяет читать комментарии при разработке программного обеспечения, а не создавать статический контент все время.

Ответ 9

Все что вам нужно: http://www.helixoft.com/vsdocman/overview.html

Ответ 10

Я потратил несколько дней на изучение инструментов для создания документации на С#, и я нашел Doxygen моим любимым. Я также написал сообщение об этом в своем блоге.

Ответ 11

У меня была презентация о кодовых контрактах на прошлой неделе. Это отличный способ .NET 4.0 для документирования вашего кода. В любом случае, никто не готов. Но с кодовым контрактом вы видите код и документ в то же время

см.: http://codebetter.com/blogs/matthew.podwysocki/archive/2008/11/08/code-contracts-and-net-4-0-spec-comes-alive.aspx