Sağduyu blok başlığı için Doxygen yorum, sınıflar, yapılar, çeteleler, fonksiyonlar, tanımlamalar dosyaları nerede olduğunu söyler. Bu bir kütüphaneleri kaynağı (nesne kodu ile sadece başlıkları ve libs) olmadan dağıtılacak demek için sağlam bir argüman olduğunu kabul ediyorsunuz.

AMA...düşünüyordum tam kaynak kodu ile birlikte kullanılacak olan şirket iç (ya da kendim için bir yan proje gibi) bir kütüphane geliştiriyorum zaman tam tersi bir yaklaşım. Önerim sınıfları ve fonksiyonları başlığında beyan edilen arabirime dağınıklığı için uygulamalar dosyaları (HES, İÇERİ, CPP, vb) geniş yorum blokları yerleştirmek.

Artıları:

• Başlık dosyalarında daha az karmaşa, işlevleri kategorize eklenebilir.
• Örneğin Intellisense kullanıldığında önizlemesi bu açıklama bloğu çatışması değil - bu bir fonksiyon için bir açıklama bloğu var ne zaman gözlemlediğim bir kusurdur .H dosyası ve aynı satır içi tanımı var .Ama H dosyası dahil .Dosya İÇERİ.

Eksileri:

• (Belli bir) blok başlığında değil yorum bildirimleri olduğu dosyalar.

Ne düşünüyorsunuz ve muhtemelen önerdin?

İnsanlar okuyacak nerede belgelere koymak ve kullanarak ve kod üzerinde çalışıyoruz olarak yazıyorum.

Sınıf yorum yöntemleri önünde sınıfları, yöntem yorumların önüne geçer.

Şeyler korunur emin olmak için en iyi yoldur. Bunu ayrıca başlık nispeten yalın dosya ve önler tutarçok dokunaklıinsanlara yöntem güncellenmesi konu başlıkları kirli neden ve yeniden tetikleme dokümanlar. Aslında insanlar belgelerine yazmak için bir bahane olarak kullanma tanıyorumdaha sonra!