Kodunuzu çok düzgün bir şekilde anlaşılır hale getirmek istiyorsanız C# dilini kullanan arkadaşlar için çok yararlı bir yöntem olan XML commentler yaratalım...
XML comment'ler(açıklamalar) class, delegate, field, event, property ve method düzeyinde açıklamalar girmenize izin veriyor.
XML comment'ler eklemek için, C# kodunuzda açıklama girmek istediğiniz ögenin bir satır üstüne giderek /// yazın. 3. slash işaretini koyduğunuzda XML comment'ler bölümü otomatik olarak belirecektir;
/// <>
///
/// < /summary >
/// < name="parametre1"> < /param >
Örneğin class'ınız için summary bölümüne bir açıklama girebilirsiniz. Param elementi ise parametrenin ismini sizin yazdığınız method'dan alıyor ve oraya bir attribute olarak ekliyor. Daha sonra siz methodunuza ait parametreniz için de bir açıklama girebiliyorsunuz. Bir method için minimal bir XML açıklaması aşsağıdaki gibi olmalı;
/// <>
/// Bu method Butun kontroller'i loop ederek
/// Textbox'larimin degerlerini kontrol edecek
///
/// < name=""> Form veya kontrol.< /param >
private void TextboxKontrolu(Control parametre1)
XML commenting aracı bunlardan hariç başka elementler kullanmanıza da izin vermekte. Örneğin;
Example: Methodun veya bir öğenin nasıl kullanılacağına dair bilgiler girmenizi sağlar.
Exception: Methodunuzda hangi istisna durumların oluşabileceğini belirtmenize yarar.
Returns: Methodunuzun geri vereceği değeri belirtmenize yarar.
C# XML açıklamaları konusunda daha fazla bilgi için Visual Studio Help'deki "XML Documentation tütorial" başlığına da bir bakmanızı öneririm...
