(Visual Basic) kodunda yorumlar
Kod örnekleri okuduğunuz gibi genellikle yorum sembol karşılaştığınız (').Bu simge söyler Visual Basic , aşağıdaki metni yoksaymasını derleyici veya Yorum.Kod yararına göre olanlar okumadan eklenen kısa açıklayıcı notlar açıklamalardır.
Tüm yordamların (yaptığı) yordamı işlevsel özelliklerini açıklayan kısa bir açıklama ile başlamak için uygulama programlama iyidir.Bu kendi avantaj ve herkese kod inceler yararı içindir.(Nasıl yordam bunu yapar) uygulama ayrıntılarını işlevsel özelliklerini açıklamak açıklamalardan ayırmak.Uygulama ayrıntıları Açıklama alanına eklediğinizde, bunları işlevi güncelleştirdiğinizde güncelleştirmeyi unutmayın.
Açıklamalar bir deyiminin aynı satırda izleyin veya satırının tamamını kaplar.Her ikisi de aşağıdaki kodda gösterildiği gibidir.
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
Yorumunuzu birden fazla satır gerektiriyorsa, aşağıdaki örnekte gösterildiği gibi yorum sembolü her satırda 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 oluşturma yönergeleri
Aşağıdaki tabloda, kod bölümü ne tür yorumlar için genel kurallar koyun sağlar.Öneriler şunlardır; Visual Basicyorum eklemek için kurallar zorlamaz.Ne, hem de sizin için iyi yazma ve kimin Kodunuzu okuyan herkes için.
Yorum türü |
Açıklama açıklama |
Purpose |
Yordam ne yaptığını (nasıl onu yok) |
Varsayımlar |
Her dış listeler değişkeni, Denetim, açık dosya veya yordam tarafından erişilen diğer öğe |
Efektleri |
Listeleri her etkilenen dış değişkeni, Denetim veya dosya ve (yalnızca belirgin değilse) olan etkisi |
Girdileri |
Bağımsız değişken amacını belirtir |
Döndürür |
Yordam tarafından döndürülen değerleri açıklar. |
Aşağıdaki hususları unutmayın:
Her önemli değişken bildiriminde bildirilen değişken kullanımını açıklayan bir açıklama öncesinde.
Değişkenler, denetimleri ve yordamları yeterince açıkça yorum oluşturma yalnızca karmaşık uygulama ayrıntıları için gerekli olan adlı olmalıdır.
Yorum satırı devamı sırası aynı satırda gelemez.
Eklemek veya bir veya daha fazla kod satırlarını ve seçerek bir kod bloğu için yorum simgelerini kaldırmak Yorum (.gif "VisualBasicWinAppCodeEditorCommentButton")
) ve Uncomment (.gif "VisualStudioWinAppProjectUncommentButton")
) üzerinde düğmeleri düzenleme araç.
[!NOT]
Metinle koyarak kodunuza açıklamalar ekleyebilirsiniz REM anahtar sözcüğü.Ancak, ' simge ve Yorum/Uncomment düğmeleri daha kolay ve daha az boş alan ve bellek gerektirir.