Aracılığıyla paylaş

Koddaki Açıklamalar (Visual Basic)

Kod örneklerini okurken genellikle açıklama simgesiyle (') karşılaşırsınız. Bu simge, Visual Basic derleyicisine bunu izleyen metni veya açıklamayı yoksaymalarını söyler. Açıklamalar, kodu okuyanların yararına koda eklenen kısa açıklayıcı notlardır.

Tüm yordamlara, yordamın işlevsel özelliklerini (ne yaptığı) açıklayan kısa bir açıklamayla başlamak iyi bir programlama uygulamasıdır. Bu, sizin kendi yararınıza ve kodu inceleyen herkesin yararınadır. Uygulama ayrıntılarını (yordamın nasıl yaptığı) işlevsel özellikleri açıklayan açıklamalardan ayırmanız gerekir. Açıklamaya uygulama ayrıntılarını eklediğinizde, işlevi güncelleştirdiğinizde bunları güncelleştirmeyi unutmayın.

Açıklamalar aynı satırdaki bir deyimi izleyebilir veya satırın tamamını kaplayabilir. Her ikisi de aşağıdaki kodda gösterilmiştir.

' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!"   ' This is an inline comment.

Açıklamanız birden fazla satır gerektiriyorsa, aşağıdaki örnekte gösterildiği gibi her satırda açıklama simgesini kullanın.

' This comment is too long to fit on a single line, so we break 
' it into two lines. Some comments might need three or more lines.

Yorum Yapma Kılavuzu

Aşağıdaki tabloda, kodun bir bölümünden önce hangi açıklama türlerinin geçebileceğine ilişkin genel yönergeler sağlanmaktadır. Bunlar önerilerdir; Visual Basic, açıklama eklemek için kuralları zorunlu kılmaz. Hem sizin hem de kodunuzu okuyan herkes için en iyi sonucu yazın.

Açıklama türü Yorum açıklaması
Amaç Prosedürün ne yaptığını açıklar (nasıl yaptığını değil)
Varsayımlar Prosedür tarafından erişilen her dış değişkeni, kontrolü, açık dosyayı veya diğer öğeleri listeler.
Etkiler Etkilenen her dış değişkeni, denetimi veya dosyayı ve sahip olduğu etkiyi listeler (yalnızca belirgin değilse)
Girişler Bağımsız değişkenin amacını belirtir
İade Yordam tarafından döndürülen değerleri açıklar

Aşağıdaki noktaları unutmayın:

  • Her önemli değişken bildiriminin önünde, bildirilmekte olan değişkenin kullanımını açıklayan bir açıklama bulunmalıdır.

  • Değişkenler, denetimler ve yordamlar, açıklama oluşturmanın yalnızca karmaşık uygulama ayrıntıları için gerekli olduğu kadar net bir şekilde adlandırılmalıdır.

  • Açıklamalar aynı satırdaki bir satır devamlılığı dizisini takip edemez.

Bir veya daha fazla kod satırı seçip Düzenle araç çubuğundaki The Visual Basic Comment button in Visual Studio.The Visual Basic Comment button in Visual Studio.Açıklama () ve Açıklamayı The Visual Basic Uncomment button in Visual Studio.Kaldır () düğmelerini seçerek bir kod bloğu için açıklama simgeleri ekleyebilir veya kaldırabilirsiniz.

Uyarı

Ayrıca, metnin önüne anahtar sözcüğünü REM ekleyerek kodunuza açıklama ekleyebilirsiniz. Ancak, ' simge ve Açıklama/Açıklama Kaldırma düğmelerinin kullanımı daha kolaydır ve daha az alan ve bellek gerektirir.

Ayrıca bakınız