Есть ли в Visual Studio возможность генерировать HTML-документацию для комментариев в стиле Javadoc?

Question

Есть ли в Visual Studio возможность генерировать HTML-документацию для комментариев в стиле Javadoc? Если да, какие шаги необходимы для этого?

В BlueJ есть возможность переводить комментарии в стиле Javadoc в html-файл.

Как показано на следующем рисунке для Java с использованием BlueJ, я хочу сделать то же самое с Visual Studio:
_{(источник: time-tripper.com )}

Answer 1

Вы действительно имеете в виду JavaDoc, в Java? Если это так, я не верю, просто используйте сам Javadoc. Visual Studio на самом деле не поддерживает Java.

Если вы имеете в виду комментарии к документации C # XML, то вы можете изменить свойства проекта для создания файла XML, а затем использовать NDoc (прекращено) или Sandcastle для построения HTML (или чм и тд). По общему признанию, это не так просто, как могло бы быть.

РЕДАКТИРОВАТЬ: Если вы используете C ++, вам, вероятно, следует взглянуть на Doxygen . Там могут быть плагины Visual Studio, но вам лучше всего запустить Doxygen в процессе сборки. Если вы используете C ++ / CLI, может быть какой-то эквивалент комментариев C # XML, но я не знаю об этом.

Answer 2

Вы можете использовать Javadoc-совместимый стиль комментирования, либо вводя комментарии вручную, либо использовать мое дополнение, Документация Atomineer Pro , чтобы извлечь большую часть работы из него. Затем для генерации внешней документации используйте doxygen , который радостно читает javadoc.

Альтернативой является (как сказал Джон) использование комментариев в формате XmlDoc, которые могут использоваться Visual Studio (для всплывающих подсказок для intellisense), Atomineer, Sandcastle и Doxygen. Это менее читаемый формат, но он дает вам значительные преимущества в среде Visual Studio, поэтому он немного более гибкий.

Оба подхода будут работать для C #, C ++, C (хотя C # работает лучше с точки зрения интеллигенции)