ddoc - Ddoc

Ddoc bir derleyici-gömülü olduğu belgelerine jeneratör için ve ilgili sözdizimi, D programlama dili tarafından tasarlanan, Walter Bright . Onun vurgu, doğal bir tarzda kod açıklamalarda belgeleri yazmak mümkün gömülü biçimlendirme ihtiyacını minimize ve böylece kod yorumların okunurluğunu artırmak üzerindedir. Bu kavram benzer olan Doxygen ve Javadoc .

Kod yorumları koda semboller ile ilişkilidir ve ddoc böyle parametreler gibi rutin bilgileri doldurun ve otomatik tipleri dönmek için D derleyici edinilebilir anlamsal ve sözdizimsel bilgileri kullanır.

Kodu yorumlar ve sembol tablosu bilgileri bir iç yapısal biçime ddoc tarafından işlenir. Bu yapıların her biri olarak ifade edilen, bir şablon tekabül makro . Şablon makrolar işaretlemeyi ifade makro başka bir set haline yapılandırılmış biçimde dönüştürün. İşaretleme makro ikincisi seti, varsayılan olarak, üretmek için genişletilir HTML .

Şablon makrolar ve işaretleme makroları Hem kullanıcı tarafından geçersiz kılınabilir ve HTML stil sayfaları benzer dış dosyaları yoluyla uygulanabilir. Şablon makrolar yüksek düzeyde biçimlendirme özelleştirmek için değiştirilebilir, ve işaretleme makrolar gibi diğer çıkış formlarını üretmek için değiştirilebilir XML ve XHTML .

derleyici seçenekleri

Çeşitli derleyici seçenekleri çıkışı bir html belgesi dosyası için dmd D derleyici neden mevcuttur:

  • belgeleri oluşturmak -D - çıkış "html" ile ikame ".d" uzantısı ile D kaynak dosyası ile aynı adı olur.
  • -DD ​​<dizin> dizine yazma belgesi dosyası, çıktı dosya -D seçeneğinden aynıdır.
  • -Df <filename> dosya adına yazma belgesi dosyası (otomatik .html uzantısını etmez)


Dış bağlantılar