Kodunuzu Anlaşılır kılma ve yazacağınız bilgi satırları ile Yardım dosyası oluşturma

Kodunuzu daha okunaklı kılmak için öncelike yapmanız gereken kod bloklarınızdan önce /// (üç bölü) yazmanız ve visual studio 2005 editörünün sizin için oluşturacağı bölümleri doldurmak.

/// <summary>
/// Bu sınıf Kişi verisi ve bu veri üzerinde yapılacak işlemleri içerir.
/// </summary>

Böylece ilgili kodunuz (class, method, vb.) kullanırken Visual Studio 2005 Editörü geliştirmeyi yapan kişiye gösterdiği tooltiplerde daha fazla bilgi verebilir.

Not:İlgili Tanım bloğu ile tanımladığı kod bloğu arasında boş satır olmamalıdır. Açıklama ile kod peş peşe yer almalıdır.

Ayrıca bu oluşturduğunuz bölümleri XML dosyasına aktarabilirsiniz.

Bu işlem için derleme parametrelerinde oluşturulacak XML dosyasının adı belirtilmelidir. Bunu yapmak için proje özelliklerinde build sekmesinde XML documentation file özelliği ayarlanmalıdır.

Bu işlemden sonra derleme sonucu gerekli XML belgesi oluşur.

Bundan sonra bu XML belgesi ile ne yapacağınız size kalıyor…

Örneğin bu dosyayı piyasada bulabileceğiniz uygulamalar ile kullanıp kendi yardım dosyalarınızı oluşturabilirsiniz.

Bu programlara NDoc örnek olarak verilebilir.
http://sourceforge.net/projects/ndoc/

Ayrıca bir XSL yardımı ile XML dosyanızın daha anlamlı görüntülenmesini de sağlayabilirsiniz…
http://www.codeproject.com/soap/XMLDocStylesheet.asp

Klavyeler şen ola…

Yazı oluşturuldu 141

Bir yanıt yazın

Benzer yazılar

Aramak istediğinizi üstte yazmaya başlayın ve aramak için enter tuşuna basın. İptal için ESC tuşuna basın.

Üste dön