XML yorumları ve Doxygen ile C# projeleri/derlemeleri nasıl belgelendirilir?

Question

XML yorumlarına sahip bir C# kod tabanım var ve (owing to this site), Doxygen'un kod ve yorumları HTML ve PDF belgelerine kolayca oluşturabildiğini keşfetti. Bu nedenle, sınıfları ve diğer türleri ve içeriklerini nasıl belgeleyeceğimi biliyorum.

Peki, projeler/derlemeler/ad alanları nasıl belgelenmeli? Kod tabanımın 50'den fazlası var; sorumlulukları belgelenmelidir.

Sadece yanı üzerlerinde XML açıklamaları kullanmayı tercih ediyorum

. ama Microsoft's XML commenting manual, bunun nasıl yapılacağına dair bir ipucu vermez ve Doxygen belgelerinde de hiçbir ipucu bulamıyorum.

Neyi eksik? C# projeleriniz/montajlarınız için nasıl dokümantasyon sağlıyorsunuz?

Güncelleme: Şimdi biliyorum how to do it with SHFB.

Answer 1

Biz de meclislerimizin belgelerini oluşturma sürecindeydik. 20-25 dll'imiz var. Sandcastle [SHFB] 'yi kullandık ve onun bir parça kek oldu. Aşağıdaki prosedürü kullandık.

1. Kontrol Projesi özellikleri [ClassLibrary] içinde XML Documentation file ve ardından gerekirse başka XML bin \ debug veya bin \ release klasöründe oluşturulur özel bir yolu sağlar.
2. Sonra
3. Sonra bir klasördeki tüm ön koşul dll dosyaları yerleştirir SandCastle
gelen GUI kadar harekete ve sonra biz DLL dosyaları ve UI xml dosyalarına işaret eder ve sonra biz inşa edecek uygulama. Bu, web'de bir web yardımı olarak yayınlamak için kullanabileceğiniz web sayfalarının yanı sıra CHM oluşturacaktır.

biraz Googling mutlaka durumunda

Eğer bakınız sadece doxygen kullanmak gerektirir .. seni çok ekran görüntüsü bazlı örnek verecek here