Menu

Документация

D старается интегрировать важные аспекты современной разработки ПО непосредственно в язык. Помимо контрактного программирования и юнит-тестирования, D позволяет генерировать документацию непосредственно из исходного кода.

Используя стандартную схему документации для типов и функций, команда dmd -D генерирует документацию в виде HTML, на основе исходных файлов, переданных через командную строку. Вся документация библиотеки Phobos на самом деле генерируется с помощью DDoc.

DDoc рассматривает следующие стили комментариев для включения в документацию кода:

  • /// Три слэша перед типом или функцией
  • /++ Многострочный комментарий с двумя + +/
  • /** Многострочный комментарий с двумя * */

Взгляните на пример кода, чтобы получить представление о некоторых стандартных разделах документации.

Подробнее

rdmd playground.d