Как сделать XML-документацию в Visual Studio 2012

Как я могу создать документацию моего веб-приложения C# в Visual Studio 2012, как это делает Eclipse?


person soamazing    schedule 13.12.2012    source источник
comment
Что вы пробовали? (Несколько необычно публиковать XML-документацию для веб-приложения, IMO. Библиотеки классов, конечно, но что будет ссылаться на веб-приложение?)   -  person Jon Skeet    schedule 13.12.2012
comment
@SaniHuttunen, но это не важно, просто потому, что он парень, с которым он может быть грубым?   -  person soamazing    schedule 13.12.2012
comment
Хорошо @SaniHuttunen!! Прости, Джон! Я думаю, что VS2012 имеет те же инструменты Eclipse для создания документации!!   -  person soamazing    schedule 13.12.2012


Ответы (4)


В Visual Studio перейдите в меню инструментов -> диспетчер расширений... затем в диспетчере расширений щелкните онлайн-галерею (слева), затем введите в правом верхнем поле поиска текст... ghostdoc Это очень хороший помощник по работе с документами.

person Paul Zahra    schedule 13.12.2012

Вы можете прокомментировать свой код, используя комментарии xml

/// <summary>
///  This class performs an important function.
/// </summary>

а затем сгенерируйте XML-документацию после компиляции файла /doc. Вот источник: http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

также я советую вам использовать Sandcastle с его Help File Builder, который является очень мощным инструментом: http://shfb.codeplex.com/

person Ali Issa    schedule 13.12.2012
comment
Sandcastle теперь поддерживается за пределами Microsoft и имеет страницу, посвященную веб-проектам ewoodruff.us/shfbdocs/html/ - person Stephen Kennedy; 26.09.2014

Пожалуйста, ознакомьтесь с этим сообщением: Бесплатный инструмент для разработки XML-документации Visual Studio

Они советуют инструмент sandcastle.

person J-man Venk    schedule 13.12.2012

Вы можете использовать ghostdoc для XML-документации.

http://submain.com/products/ghostdoc.aspx

Вы можете использовать замок из песка для создания справочного документа

http://sandcastle.codeplex.com/

person Raghav    schedule 19.12.2012