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

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

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

Как показано на следующем рисунке для Java с использованием BlueJ, я хочу сделать то же самое с Visual Studio: http://www.time-tripper.com/uipatterns/Patterns/Titled_Sections/javadoc.gif
(источник: time-tripper.com )


person Brandon Tiqui    schedule 20.12.2009    source источник
comment
Можете ли вы подробнее рассказать о том, чего вы пытаетесь достичь?   -  person Alon    schedule 20.12.2009
comment
@Alon Я использую C++ в Visual Studio.   -  person Brandon Tiqui    schedule 20.12.2009


Ответы (2)


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

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

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

person Jon Skeet    schedule 20.12.2009
comment
С Sandcastle мне было ужасно использовать. Для создания документации требуется буквально семь сложных шагов. Однако есть проект (сейчас я не вспомню название, Google его узнает), который строит SandCastle вокруг графического интерфейса и делает его красивым и простым в использовании. Вы также можете подключить его к процессу сборки. - person Finglas; 20.12.2009
comment
Проголосовав за ваш ответ, я удалю свой. Я неправильно понял вопрос. :) - person GrayWizardx; 20.12.2009
comment
Возможно, конструктор файлов справки Sandcastle: codeplex.com/SHFB... похоже, это внешний интерфейс для Песчаного замка. - person ChrisW; 06.01.2010
comment
Как упомянул Крис, Sandcastle Help File Builder упрощает создание документации. - person Tejasvi Hegde; 12.07.2014

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

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

Оба подхода будут работать для C#, C++, C (хотя C# лучше работает с intellisense)

person Jason Williams    schedule 20.12.2009