Ben 2 başlık dosyaları var düşünün doxygen.Documenting ad
Doxygen ile belgeleyen zaman bu işlemesi gereken Nasıl// HEADER 2
/**
* Doc for Foo here?
*/
namespace Foo {
class That {...};
}
// HEADER 1
/**
* Doc for Foo here?
*/
namespace Foo {
class This {...};
}
& &?
Belki de. Örneğin, namespace utility ve "<root>/utility/header2.hpp" içeriğine sahip olan "<root>/utility/header1.hpp" ürününüzün var olduğunu düşünün.
Bir dosya ekleyebilirsiniz: utility ad belgeleyen "<root>/utility.hpp". Yanlışlıkla dahil edilmediğinden emin olmak için bunu en iyi #error Documentation only. numaralı telefona koyabilirsiniz.
Ama en azından
dokümantasyon için iyi bir yer bulun (ve rastgele bazı sınıf ile karışık değil.) Aklı başında bir yerde tutmak için bazı out-of-the-way dosyası yapma öneriyoruz, bu dosyalardan birinde mi yoksa tamamen mi? Doxygen en ad etiketine sahip bir yorum bloğu kullanın: Burada
/**
* @namespace Foo
* Documentation for Foo here. More docs for Foo here,
* and down here.
*/
Dokümanlar: http://www.stack.nl/~dimitri/doxygen/commands.html#cmdnamespace
Her ad alanı için özel bir dosya olması gerekmez. Projeniz için ön sayfa belgelerini sağlayan bir global "proje belgeleri" dosyası kullanabilir, grupları düzenleyebilir (grup içi etiketlerle kullanım için) ve ad alanlarını tek bir yerde belgeleyebilirsiniz. Bu, tüm "gözden geçirmelerin" rüzgara yayılmak yerine tek bir mantıksal yerde tutulmasına izin verir. Bu temel belgeleri, doxygen konfigürasyon dosyaları vb. Gibi şeyler içeren bir "documentaiton" klasörüne bile koyabilirsiniz. –
@Jason Bu cevabı okuduktan sonra, aslında ona doğru eğildim. İyi bir plan gibi görünüyor. – rhubarb
@JasonWilliams: Bence teklifiniz kendi başına bir cevap. Bunun daha iyi bir yaklaşım olduğuna inanıyorum. – NobodysNightmare