46
C++ için Javadoc benzeri benzer belge oluşturma sistemleri var mı? Javadoc güzel çıktı üretir; Başka dillerdeki gibi bir şey kullanabilmeniz harika olurdu.Javadoc benzeri Documentation for C++
A
cevap
53
++ en popüler aracı muhtemelen Doxygen olduğunu. JavaDoc benzeri yorumları ve ayrıca birkaç dili (örneğin C++, C, Java, Objective-C, Python, PHP, C#) kullanabilir. CSS kullanarak HTML çıktısının stilini değiştirmek için oldukça iyi bir desteğe sahiptir (örneğin, dokümantasyonlar için users list'a bakın). dokümantasyon sistemi seçme
iki önemli konular o
- Belgesinde ilgilendiğiniz kişiler sizi izin verdiğinden emin kılmaktır. Eğer kod yapısı aşağıdaki ya göre sistem belgelemek istiyor musunuz başka bir modül bölümü.
- Çıkışı istediğiniz gibi biçimlendirin. Belgelerin genel proje stilinize uygun olması tercih edilir.
Doxygen ile ilgili deneyimimiz, kurulumu ve kullanımı oldukça kolaydır ve sonuçta elde edilen çıktının ince ayarlanması oldukça kolaydır. Ne yazık ki, oksijen dozu mükemmel değildir, bu nedenle bazı durumlarda doxygen çözümleyicinin bozulduğu yerdeki tuhaflıklar veya hatalar üzerinde çalışmak gerekir. Oluşturduğunuz tüm dokümanları dikkatle incelediğinizden emin olun.
11
Sen Özellikle javadoc kullanamazsınız Doxygen
20
1
QT tabanlı C++ projeleri için qdoc da vardır. http://doc-snapshot.qt-project.org/qdoc
0
Python projelerim için Sphinx'u kullanmaya başladım. Ana sayfa "C/C++ zaten desteklenmektedir" diyor.
"reStructuredText" adı verilen hafif bir işaretleme kullanır.
Python projelerim için kullanmaya başladım ve çıktıların görünümünü çok beğendim.
Ayrıştırıcıyı ayrıştırmakla ilgili olarak, XML yorumlama kullanmaya geçtiğimde sorunların giderildiğini fark ettim, ancak daha sonra editörlerin ve IDE'nin pek çoğunun desteklenmediğini destekledim. –