У меня есть проект Visual Studio (C #), в котором включено свойство «XML-файл документации». Также для параметра «Обрабатывать предупреждения как ошибки» установлено значение «Все». Есть один конкретный класс, у которого нет комментариев XML, и...

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

Было опубликовано много вопросов и ответов об API на основе REST/HTTP и т. д., но ни один из них, похоже, не содержит достаточной информации по следующему вопросу: Какие инструменты доступны/используются для документирования API HTTP-RPC? Какие...

Я использую mogenerator для создания Основные данные . Mogenerator производит машинные классы и человеческие классы. Разработчик не должен модифицировать сгенерированные машиной классы, так как они генерируются каждый раз, когда вызывается...

Как документировать методы с параметрами, используя строки документации Python? EDIT: PEP 257 приводит следующий пример: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part...

Как следует из названия, как использовать luadoc в Ubuntu/Linux? Я создал документацию в Windows, используя командный файл, но безуспешно в Ubuntu. Есть идеи? luadoc Usage: /usr/bin/luadoc [options|files] Generate documentation from files....

Есть ли стандартный или существующий способ сгенерировать «что-то» из нескомпилированного класса Java на основе его содержимого? Итак, в основном что-то вроде этого: @MakeJsonDocumentation public class ExistingClass{ private name = "";...

Недавно я изменил имя dll моего проекта с ObjectCreator1.1.dll на ObjectCreator.dll . Этот проект также создает XML-документацию (Properties->Compile->Generate XML Documentation file). Теперь проблема в том, что я переименовал имя своей сборки со...

Как мне назвать тег Doxygen @ref ? Я пробовал следующее: See @ref hello_world hello for more information Что выводит это: See hello_world hello for more information Где hello_world связано с hello_world . Я ищу этот вывод:...

Как избежать недопустимых символов VB и C-Sharp, таких как <>& , в теге <code> документации .Net Xml? В приведенном ниже примере Intellisense выделяет символ > , потому что мне нужно его экранировать, он говорит, что код не...

У меня есть вопрос о пакете "roxygen2" : Я видел много руководств, в которых он используется для документации пакетов (например, основной "object documentation" , автор Hadley Wickham) Так что, если у меня есть код R, который не является...

Я ищу способ настроить html, сгенерированный Dokka, чтобы включить собственный заголовок и нижний колонтитул. Ранее я использовал Doclava, чтобы переопределить шаблон для сгенерированного HTML, и мне было интересно, есть ли способ сделать это в...