.NET Kodunu Dokümante Etme

26-11-2004

Kod geliştirirken ki en ciddi sorunlardan biri kodu dokümante etmektir, hadi ettiniz bir de ondan sonra bu kodun dokümantasyonuna rahat okunabilir/ulaşılabilir bir formata çevirip kullanmaktır.

VS.NET bizi IDE' si ile kendine hayran bıraktı zaten, şimdi bu konuya da üçüncü parti çözümlerle destek veriyor. VB veya C# ile geliştirdiğiniz kodun dokümantasyoununu direk VS içerisinden yapabilirsiniz. Bildiğimiz gibi zaten bazı belli kod dokümantasyon standartları var. MSDN Magazine "XML Comments Let You Build Documentation Directly From Your Visual Studio .NET Source Files" başlıklı makalede XML standartları ve temel-yeterli bir makale var.

C# için açık kaynak kodlu NDoc bu konuda hakikaten kendini aşmış, son beta versiyonu çok güçlü.
VB içinse VBCommenter gene açık kaynak kodlu ve diğer güzel bir yazılım.

İkisinin de çalışma mantığı çok pratik, yapmanız gereken tek şey VB için 3 defa tırnak koyup "'''" Enter 'a basmak, C# içinse "///" 3 defa slash koyup Enter 'a basmak.

Bu dokümantasyon ve yardım sektörü orjinal, Mesela Helpware diye bir site var. Son olarak NDoc ile ilgili makaleler hoşunuza gidecektir. Bunları kurcalarken iki site daha ilgimi çekti. VB Class Designer ve Kaynak Kodu arama modtoru Koders.

Eğer VBCommenter' da

"The Add-in 'VBCommentor' failed to load or caused an exception....
Error Message <Unknown Error>
Error number 80131513 "

ki ben aldım, VBCommenter' ın klasöründeki office.dll' i Visual Studio IDE' sinin klasörüne kopyalayıp tekrar kuru çalıştırın ve repair' ı seçin. (Klasör C:\Program Files\Microsoft Visual Studio .NET 2003\Common7\IDE gibi bir şey olmalı)

Recent Blog Posts

See all of the blog posts