Ddoc - Ddoc

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

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

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

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

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

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

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


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