Подтвердить что ты не робот

Создать html-документацию для кода С#

Обычно я не занимаюсь разработкой С#, поэтому, пожалуйста, извините мою нобость, но я в настоящее время работаю над проектом С#, а VisualAssist генерирует эти фантастические комментарии /// <summary></summary> для меня, и я использовал их для документирования своего кода.

Я предполагаю, что должен быть способ использовать эти комментарии для создания html-документации, как это сделано Doxygen или Javadoc. Как я это сделал?

4b9b3361

Ответ 1

Doxygen или Конструктор файлов подсказок Sandcastle основные инструменты, которые будут извлекать документацию XML в HTML (и другие формы) внешней документации.

Обратите внимание, что вы можете объединить эти документы с экспортерами документации - как вы обнаружили, у Resharper есть некоторые рудиментарные помощники, но есть также гораздо более сложные инструменты для выполнения этой конкретной задачи, такие как GhostDoc (для кода С#/VB с документацией XML) или моей addin Документация Atomineer Pro (для С#, С++/CLI, С++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript-код, содержащий XML, Doxygen, JavaDoc или Qt-документацию).

Ответ 2

В 2017 году, ближайшая к Javadoc, вероятно, DocFx, которая была разработана Microsoft и поставляется в виде Commmand-Line-Tool как а также плагин VS2017.

Это все еще немного грубо по краям, но выглядит многообещающе.

Другой альтернативой будет Wyam, в котором есть рецепт документации, подходящий для сетевых приложений. Посмотрите на документацию торта для примера.

Ответ 3

Вы можете попробовать https://www.docify.net/ Они делают именно это.

Ответ 4

Вышеупомянутый метод для Visual Studio, похоже, не применим к Visual Studio 2013, но я смог найти описанный флажок в меню Project и выбрать мой проект (возможно, последний элемент в подменю), чтобы перейти к диалогового окна с флажком (на вкладке "Сборка" ).

Ответ 5

Эта страница может вас заинтересовать: http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

Вы можете создать файл документации XML, используя либо компилятор командной строки, либо через интерфейс Visual Studio. Если вы компилируете компилятор командной строки, используйте опции /doc или/doc+. Это создаст файл XML с тем же именем и по тому же пути, что и сборка. Чтобы указать другое имя файла, используйте /doc: файл.

Если вы используете интерфейс Visual Studio, существует параметр, определяющий, будет ли создан файл документации XML. Чтобы установить его, дважды щелкните Мой проект в обозревателе решений, чтобы открыть конструктор проекта. Перейдите на вкладку "Компиляция". Найдите "Создать файл документации XML" в нижней части окна и убедитесь, что он установлен. По умолчанию этот параметр включен. Он генерирует XML файл с использованием того же имени и пути, что и сборка.