當您閱讀程式代碼範例時,通常會遇到批注符號 ('
)。 此符號會告知 Visual Basic 編譯程式忽略其後面的文字或 批注。 批註是新增至程式代碼的簡短說明附註,以利於閱讀程序代碼。
以簡短的批注來開始所有程式,描述程式的功能特性(其用途)是很好的程式設計做法。 這是為了您自己的利益,以及檢查程序代碼的任何其他人的利益。 您應該將實作詳細資料(程式如何執行)與描述功能特性的批注區隔開。 當您在描述中包含實作詳細數據時,請記得在更新函式時加以更新。
註解可以跟在一行語句之後,或佔據整行。 下列程式代碼會說明這兩者。
' This is a comment beginning at the left edge of the screen.
text1.Text = "Hi!" ' This is an inline comment.
如果您的批注需要一行以上,請使用每一行的批注符號,如下列範例所示。
' 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.
評論指導方針
下表提供程式碼區段之前批注類型一般指導方針。 以下是建議:Visual Basic 不會強制執行新增批注的規則。 為您和讀取程式代碼的其他人撰寫最適合的內容。
批注類型 | 批註描述 |
---|---|
目標 | 描述程式的功能(而不是程式的運作方式) |
假設 | 列出程式所存取的每個外部變數、控制項、開啟檔案或其他元素 |
影響 | 列出每個受影響的外部變數、控制項或檔案,以及它具有的效果(只有當它不明顯時) |
輸入 | 指定參數的用途 |
退貨 | 說明程式所傳回的值 |
請記住下列幾點:
每個重要的變數宣告前面都應該有一個批注,描述所宣告之變數的使用方式。
變數、控件和程序應該清楚命名,只有複雜的實作詳細數據才需要批注。
批注不能遵循相同行上的行接續序列。
您可以選取一或多行程式碼,然後選擇 [Visual Studio] 中的 [Visual Basic 註解] 按鈕和 [取消註解] 按鈕,以新增或移除程式碼區塊的註解符號,這些按鈕位於 [編輯] 工具列上。
備註
您也可以在文字前面加上 REM
關鍵詞,將註解新增至您的程式碼。 不過, '
符號和批 注/取消批注 按鈕更容易使用,而且需要較少的空間和記憶體。