Я в настоящее время работаю над проектом C#, и VisualAssist генерирует эти фантастические комментарии /// <summary></summary> для меня, и я использовал их для документирования своего кода.Создайте документацию html для кода C#
Я предполагаю, что для создания этих HTML-документов должен быть способ использовать HTML-документацию, такую как Doxygen или Javadoc. Как мне это сделать?
Doxygen или Sandcastle help file builder являются основными инструментами, которые будут извлекать XML-документы в HTML (и другие формы) внешней документации.
Обратите внимание, что вы можете объединить эти экспортеры документации с генераторами документации - как вы обнаружили, у Resharper есть некоторые рудиментарные помощники, но есть также гораздо более продвинутые инструменты для выполнения этой конкретной задачи, например GhostDoc (для C#/VB код с документацией XML) или мой addin Atomineer Pro Documentation (для C#, C++/CLI, C++, C, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript-код, содержащий XML, Doxygen, JavaDoc или Qt-документацию).
Эта страница может заинтересовать: http://msdn.microsoft.com/en-us/magazine/dd722812.aspx
Вы можете создать файл XML документации либо с помощью компилятора командной строки или через интерфейс Visual Studio. Если вы компилируете компилятор командной строки, используйте опции/doc или/doc +. Это создаст файл XML с тем же именем и по тому же пути, что и сборка. Чтобы указать другое имя файла, используйте/doc: файл.
Если вы используете интерфейс Visual Studio, существует параметр, определяющий, будет ли создан файл документации XML. Чтобы установить его, дважды щелкните Мой проект в обозревателе решений, чтобы открыть конструктор проекта. Перейдите на вкладку «Компиляция». Найдите «Создать файл документации XML» в нижней части окна и убедитесь, что он установлен. По умолчанию этот параметр включен. Он генерирует XML-файл с использованием того же имени и пути, что и сборка.
Он не спрашивает, как создать XML-документацию, он спрашивает, как превратить эту XML-документацию в HTML. – Mark
Хотя ваш ответ не отвечает на вопрос ОП, он отвечает мне. Благодаря! –
Вы можете попробовать https://www.docify.net/ Они делают именно это.
Вышеупомянутый метод для Visual Studio, похоже, не применим к Visual Studio 2013, но я смог найти описанный флажок, используя меню проекта и выбрав мой проект (возможно, последний элемент в подменю), чтобы добраться до диалог с флажком (на вкладке «Сборка»).
В 2017 году ближайшая к Javadoc вещь, вероятно, была бы DocFx, которая была разработана Microsoft и поставляется как Commmand-Line-Tool, а также плагин VS2017.
Это все еще немного грубо по краям, но выглядит многообещающим.
Другой альтернативой будет Wyam, у которого есть рецепт документации, подходящий для сетевых приложений. Посмотрите на пример cake documentation.
Docfx отлично работал для меня. Я тоже работаю для VS2015 - просто добавьте пакет nuget 'docfx.console'. –
Самый проголосовавший ответ с 2009 года, но сегодня (2017) я бы сказал, что docfx - лучший способ пойти. –
DocFX, к сожалению, является большим недостатком, что он фокусируется только на документации публики. Поэтому, если вы хотите сделать некоторую документацию для внутреннего использования, которая также включает модификаторы доступа «внутренний» или «частный», это абсолютно бесполезно. Конечно ... у вас есть возможность самостоятельно изменить код и исправить это. См .: https://github.com/dotnet/docfx/issues/836 – Onsokumaru
Doxygen также работает для C#. Что с этим не так? – Etan
Но Doxygen использует различный синтаксис. Поскольку Visual Assist уже генерирует эти комментарии для меня, я бы предпочел использовать их. Редактировать: на самом деле, возможно, он поддерживает xml, я дам ему все. – jaho