VB.NET注釋正確使用方法介紹
注釋這個編程技巧,對于開發(fā)人員來說是非常重要的。尤其是初學(xué)者,一定要養(yǎng)成編寫代碼時注釋的好習(xí)慣,這樣才能幫助我們理清代碼結(jié)構(gòu),方便我們將來的檢查,更改等操作。今天為大家?guī)淼木褪怯嘘P(guān)VB.NET注釋的一些正確使用方法。
閱讀代碼示例時,經(jīng)常會遇到注釋符號 (')。此符號通知 Visual Basic 編譯器忽略在它后面的文本(即注釋)。注釋是為了方便閱讀而為代碼添加的簡短的解釋性說明。
在所有過程的開頭加入一段說明過程功能特征(過程的作用)的簡短注釋是一個很好的編程做法。這對您自己和檢查代碼的任何其他人都有好處。應(yīng)該把實(shí)現(xiàn)的詳細(xì)信息(過程實(shí)現(xiàn)的方式)與描述功能特征的注釋分開。若給說明加入了實(shí)現(xiàn)的詳細(xì)信息,切記在更新函數(shù)時對這些詳細(xì)信息進(jìn)行更新。
VB.NET注釋可以和語句同行并跟隨其后,也可以另占一整行。以下代碼闡釋了這兩種情況。
- Visual Basic
- ' This is a comment beginning at the left edge of the screen.
- text1.Text = "Hi!" ' This is an inline comment.
如果注釋需要多行,請?jiān)诿啃械那懊媸褂肰B.NET注釋符號,如以下示例所示。
- Visual Basic
- ' 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.
VB.NET注釋原則
下表提供了在一段代碼前可以加上哪些類型的注釋的一般原則。這些原則僅為建議;Visual Basic 并未強(qiáng)制實(shí)施有關(guān)添加注釋的規(guī)則。編寫注釋時,應(yīng)編寫對您和代碼的任何其他讀者都最為有效的注釋。#t#
VB.NET注釋類型以及注釋說明
用途
描述過程的用途(而不是其實(shí)現(xiàn)方式)
假設(shè)
列舉每個外部變量、控件、打開的文件或過程訪問的其他元素
效果
列舉每個受影響的外部變量、控件、文件以及它的作用(僅在作用不明顯時列舉)
輸入
指定參數(shù)的用途
返回
說明過程返回的值
請記住以下幾點(diǎn):
每個重要的變量聲明前都應(yīng)有注釋,用以描述被聲明變量的用途。
變量、控件和過程的命名應(yīng)當(dāng)足夠清楚,使得只在遇到復(fù)雜的實(shí)現(xiàn)詳細(xì)情況時才使用注釋。
VB.NET注釋不能與行繼續(xù)符同行。
通過選擇一行或多行代碼,然后在“編輯”工具欄上選擇“注釋”按鈕和“取消注釋” 按鈕,可以添加或移除某段代碼的注釋符。
注意
也可以用在文本前加關(guān)鍵字 REM 的方式給代碼添加VB.NET注釋。但符號 ' 和“注釋”/“取消注釋”按鈕更易于使用,而且需要的空間和內(nèi)存更少。