Док

Ddoc — встроенный в компилятор генератор документации и связанный с ним синтаксис для языка программирования D , разработанный Уолтером Брайтом . Основное внимание уделяется возможности писать документацию в комментариях к коду в естественном стиле, сводя к минимуму необходимость во встроенной разметке и тем самым улучшая читаемость комментариев к коду. По своей концепции он похож на Doxygen и Javadoc .

Комментарии к коду связаны с символами в коде, и Ddoc использует семантическую и синтаксическую информацию, доступную от компилятора D, для автоматического заполнения стандартной информации, такой как параметры и типы возвращаемых значений.

Комментарии к коду и информация таблицы символов обрабатываются Ddoc во внутренний структурированный формат. Каждая из этих структур соответствует шаблону, выраженному в виде макроса . Макросы шаблона преобразуют структурированный формат в другой набор макросов, выражающих разметку. Последний набор макросов разметки по умолчанию расширяется для создания HTML .

Как макросы шаблона, так и макросы разметки могут быть переопределены пользователем и применены через внешние файлы, аналогичные таблицам стилей HTML. Макросы шаблона можно изменить для настройки форматирования высокого уровня, а макросы разметки можно изменить для создания других форм вывода, таких как XML и XHTML .

Параметры компилятора

Доступно несколько опций компилятора, позволяющих компилятору dmd D выводить файл документации HTML:

/-D создать документацию — выходные данные будут иметь то же имя, что и исходный файл D, с заменой расширения «.d» на «.html».
/-Dd<directory> записать файл документации в каталог, имя выходного файла такое же, как и в опции -D.
/-Df<filename> записать файл документации в имя файла (расширение .html не добавляется автоматически)

Ссылки

Внешние ссылки

Эта инструментам программирования, статья, посвященная является незавершенной . Вы можете помочь Википедии, расширив ее .