Ddoc - Ddoc

Ddoc je vložený kompilátor generátor dokumentace a související syntaxe pro D programovací jazyk, navrhl Walter Bright. Jeho důraz je kladen na schopnost psát dokumentaci v komentářích ke kódu přirozeným stylem, minimalizovat potřebu vloženého označení a tím zlepšit čitelnost komentářů ke kódu. Koncept je podobný konceptu Doxygen a Javadoc.

Komentáře k kódu jsou spojeny se symboly v kódu a Ddoc používá sémantické a syntaktické informace dostupné z kompilátoru D k automatickému vyplňování rutinních informací, jako jsou parametry a typy návratů.

Komentáře kódu a informace o tabulce symbolů zpracovává Ddoc do interního strukturovaného formátu. Každá z těchto struktur odpovídá šabloně vyjádřené jako a makro. Makra šablon převádějí strukturovaný formát na jinou sadu maker, která vyjadřují označení. Druhá sada značkovacích maker je rozšířena tak, aby ve výchozím nastavení vytvořila HTML.

Makra šablon i makra značek mohou být uživatelem přepsána a lze je použít prostřednictvím externích souborů analogicky k šablonám stylů HTML. Makra šablon lze změnit za účelem přizpůsobení formátování na vysoké úrovni a makra značek lze změnit tak, aby vytvářela další výstupní formuláře, například XML a XHTML.

Možnosti kompilátoru

K dispozici je několik možností kompilátoru, které způsobí, že kompilátor dmd D vypíše soubor dokumentace HTML:

  • -D generovat dokumentaci - výstup bude mít stejný název jako zdrojový soubor D s příponou ".d" nahrazenou ".html".
  • -Dd zapíše soubor dokumentace do adresáře, výstupní název souboru je stejný jako z volby -D.
  • -Df zapíše soubor dokumentace do názvu souboru (automaticky nepřipojuje příponu .html)


externí odkazy