天天看點

【VB.NET機房重構】程式設計注釋

        注釋,對于開發人員來說是非常重要的。尤其是初學者,一定要養成寫注釋的好習慣。因為很多時候代碼不隻是給自己看,還會給團隊夥伴看,可以幫助了解代碼含義,發現錯誤;另一方面,即便是自己看,也有助于回想起設計想法和思路。下面就來介紹一下幾種常用的注釋方法。(以下都是以VB.NET為例)

    一、基本注釋

'調用B層,進行判斷
        Dim loginbll As New BLL.LoginBLL '執行個體化LoginBLL 
           

注釋方法:

①直接輸入英文字元的單引号,“'”. ②工具欄的常用工具
【VB.NET機房重構】程式設計注釋
③快捷鍵:Ctrl+K,Ctrl+C。

二、XML注釋         <!--****-->(可以自己敲上去,也可以直接點選工具欄的注釋工具圖示) 例如:

<!--這裡寫注釋-->
           

四、方法注釋         一般用于編寫函數或方法的時候,在三個單引号之後, 并且會自動檢查是否在類或類成員的定義的前面,如果不是,就是簡單的基本注釋;如果是,則會自動插入注釋标記,例如

【VB.NET機房重構】程式設計注釋

五、 頭檔案注釋

          頭檔案注釋是對類的描述,包含内容如下:

【VB.NET機房重構】程式設計注釋

        這種注釋是對類整體進行說明,為了一勞永逸,我們可以令其自動生成。在VS的安裝路徑中找到Class.vb檔案,如下所示:

【VB.NET機房重構】程式設計注釋
【VB.NET機房重構】程式設計注釋

        建立類的時候的效果:

【VB.NET機房重構】程式設計注釋

補充: 顯示目前時間:$time$(年份+時間) 顯示目前建立檔案名:$safeitemname$ 顯示目前工程名:$safeprojectname$ 顯示目前年份:$year$ 小結:         如果你的程式不值得注釋,那麼它很可能也不值得運作。另外注釋應該增加代碼的清晰度,簡潔明了,不要為注釋而注釋,讓我們的程式設計更專業。

繼續閱讀