Visual Studio имеет опцию генерировать документацию HTML для комментариев Javadoc-стиля?
Visual Studio имеет опцию генерировать документацию HTML для комментариев Javadoc-стиля? Если так, какие шаги необходимы для выполнения этого?
В BlueJ существует опция перевести комментарии Javadoc-стиля в файл HTML.
Как следующие шоу изображения использования Java BlueJ я хочу сделать то же с Visual Studio: 
(источник: time-tripper.com)
2 ответа
Вы действительно имеете в виду JavaDoc в Java? Если да, то я так не думаю - просто используйте сам javadoc. Visual Studio на самом деле не поддерживает Java.
Если вы имеете в виду комментарии к документации XML C #, то вы можете изменить свойства проекта для создания XML-файла, а затем использовать NDoc (прекращено) или Sandcastle для создания HTML (или chm и т. Д.). По общему признанию, это не так просто, как могло бы быть.
РЕДАКТИРОВАТЬ: Если вы используете C ++, вам, вероятно, следует взглянуть на Doxygen . Могут быть плагины Visual Studio, но лучше всего просто запустить Doxygen как часть процесса сборки. Если вы используете C ++ / CLI, могут быть некоторые эквиваленты комментариев C # XML, но я об этом не знаю.
Вы можете использовать стиль комментирования, совместимый с Javadoc, либо вводя комментарии вручную, либо использовать мой надстройку Atomineer Pro Documentation , чтобы облегчить большую часть работы. . Затем для создания внешней документации используйте doxygen , который успешно читает javadoc.
Альтернативой является (как сказал Джон) использование комментариев в формате XmlDoc, которые могут использоваться Visual Studio (для подсказок intellisense) , Atomineer, Sandcastle и Doxygen. Это менее удобочитаемый формат, но он дает вам значительные преимущества в среде Visual Studio, поэтому он немного более гибкий.
Оба подхода будут работать для C #, C ++, C (хотя C # лучше работает с точки зрения intellisense. )