Генератор документации C++ Visual Studio [закрывается]
4 ответа
Вы можете использовать формат XML-Documentation , который также поддерживается VS2010. http://msdn.microsoft.com/en-us/library/ms177226%28VS.80%29.aspx
После комментирования кода вы можете использовать Sandcastle для создания MSDN -подобная документация: http://sandcastle.codeplex.com/ . (Вот графическое представление Sandcastle, которое намного проще использовать: https://github.com/EWSoftware/SHFB )
Я использую AtomineerUtils для создания Заголовки XML-документации автоматически. Этот инструмент вам очень поможет. Вы можете получить бесплатную базовую версию здесь: http://www.atomineerutils.com/products.php
Вы можете использовать мое дополнение, Atomineer Pro Documentation , чтобы быстро создавать комментарии к документации в формате Documentation-XML, Doxygen, Qt или JavaDoc. Затем используйте Sandcastle (DocXml) или Doxygen (DocXml, Doxygen, Qt, Javadoc) для преобразования этой документации во внешние файлы документации.
Я бы рекомендовал использовать формат DocXml, потому что все вышеперечисленные инструменты работают с ним, и Visual Studio распознает его (он окрашивает его синтаксисом и встраивает документы в свою базу данных intellisense, чтобы он появлялся во всплывающей подсказке при вводе текста). имена классов / методов в ваш код).
Один из способов создания документации - как вы уже догадались - javadoc . Вам просто нужно комментировать так же, как обычно, и javadoc отлично справляется с преобразованием их в стиль HTML / LaTeX.
Конечно, это не единственное решение. Я оставлю место для других.