Как экспортировать документацию кода на С#/VisualStudio 2008?

Я всегда писал о комментариях кодов для классов и методов с синтаксисом С# xml. Я всегда ожидал, что вы сможете легко экспортировать их позже.

Сегодня мне действительно нужно это делать, но я не знаю, как это сделать. Есть что-то, что мне не хватает? Я хочу пойти Menu- > Build- > Build Code Documentation, но нет возможности сделать это там.

Ответы

Ответ 1

Собственно, это в свойствах проекта. Вкладку "Создание", раздел "Вывод", файл документации XML и введите имя файла. Он будет построен на каждой сборке проекта.

После этого вы можете создать фактическую справку Sandcastle.

Ответ 2

Вы можете попробовать NDOC или SandCastle если вы не против использования сторонних инструментов.

Ответ 3

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

Ответ 4

Sandcastle работает очень хорошо для создания документации и поддерживает несколько разных форматов для поколения. Насколько я знаю, для него нет никакой интеграции Visual Studio, но есть SandcastleGUI для нее, которая доступна.

Ответ 5

Будьте осторожны, если вы используете LINQ to SQL, так как вы не сможете легко добавлять устойчивые комментарии к автоматически сгенерированным объектам.

Ответ 6

Поздний комментарий, но стоит добавить, что даже несмотря на то, что Sandcastle законсервирован, Sandcastle Help File Builder остается в активной разработке, и я нашел его очень мощный и простой, чтобы погрузиться в дело только с этой ситуацией - установите на богатый .chm и .html/.asp вывод через пару часов.

Ответ 7

Оригинальный проект NDoc (упомянутый другими) мертв, но есть новый проект под названием NDoc3.

NDoc3 поддерживает .NET 2.0 - 3.5. В настоящее время он доступен как бета-версия и отлично подходит для меня. Я не уверен, что проект по-прежнему активен - последняя бета-версия была выпущена в апреле 2009 года.

Ответ 8

Предыдущие ответы действительно устарели. Вот еще несколько современных вариантов: