LDoc

LDoc

LDoc ...
LDoc, çeşitli Doc araçlarıyla ayarlanan kalıbı ile uyumlu olması ve bu nedenle izlenmesi gereken dokümantasyon üreticisidir: --- Özet, bir nokta ile biter.- Bazı açıklamalar, birkaç satır üzerinden olabilir.- @param p1 birinci parametre - @param p2 ikinci parametre - @ bir dize değeri döndürür @ @ second_fun işlevine bakın mod1.first_fun (p1, p2) bitiş Görme ve kullanma gibi etiketler desteklenir ve genelliklefonksiyonlar ve modüller koddan çıkarılabilir.LDoc daha iyi tanılama sağlayacak şekilde tasarlanmıştır: @see referansı bulunamazsa referansın satır numarası verilir.LDoc, module () kullanmayan modülleri bilir.Bu önemlidir, çünkü bu fonksiyon Lua 5.2'de kullanımdan kaldırılmıştır.Markdown'u kullanarak HTML'yi yorumlara gömmek zorunda kalmazsınız.LDoc ayrıca Lua C uzantı koduyla da çalışır ve bazı kullanışlı kısayollar sağlar.
ldoc

Kategoriler

Python için LDoc'a alternatifler

Sphinx

Sphinx

Sfenks, Georg Brandl tarafından yazılan ve BSD lisansı altında lisanslanan akıllı ve güzel belgeler oluşturmayı kolaylaştıran bir araçtır.