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

D намагається інтегрувати важливі елементи сучасної програмної інженерії безпосередньо у мову. Крім того контрактне програмування і модульне тестування дозволяє природнім чином генерувати документацію з вихідного коду на D.

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

DDoc розпізнає наступні стилі коментарів для включення у документацію з вихідного коду:

  • /// Три косі риски перед типом або функцією
  • /++ Багаторядковий коментар з двома + +/
  • /** Багаторядковий коментар з двома * */

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

Від перекладача: для документації та коментарів рекомендується використовувати виключно англійську мову.

Поглиблення

rdmd playground.d