ASP.NET注釋使用技巧淺析
ASP.NET注釋代碼在實際的編程中是經常出現的,并且有效的展示代碼功能信息解釋,那么ASP.NET注釋有什么使用技巧么?讓我們來看看:
ASP.NET注釋使用技巧也并非針對ASP.NET的,但它是一個良好的編程習慣。
注釋不僅僅應當說明代碼會執行什么操作,還應當注明原因。例如,不要僅僅在注釋中說明是在遍歷數組,而是要說明遍歷數組是根據某一算法計算一個值,除非算法是相當簡單的,否則還應當對算法進行簡要的說明。
.NET工程中的不同的編程語言都有各自不同的注釋符號,了解ASP.NET注釋同樣來關注下其他語言,下面是一個簡要的說明:
HTML <!-- 注釋 -->
JavaScript // 注釋
VBScript ' 注釋
VB.NET ' 注釋
C# // 注釋
/* 多行內容 的注釋 */
SQL -- 注釋
在服務器控件的開始和結束標記中沒有注釋符號,但服務器能夠忽略掉所有它不能識別的屬性,因此我們能夠通過使用沒有定義的屬性來插入注釋。下面是一個ASP.NET注釋例子:
- <asp:TextBox
- id="txtLastName"
- size="40"
- comment="這是我的注釋"
- runat="server" />
在Visual Studio .NET中對源代碼進行注釋非常簡單。高亮度顯示需要注釋的行,然后按Ctrl+K+C組合鍵添加注釋。要刪除注釋,只需高亮度顯示被注釋的代碼,并按下Ctrl+K+U組合鍵。
在ASP.NET工程中,我們還可以通過在每行的開始處使用///輸入XML注釋小節。在注釋小節中,我們可以使用下面的XML標記組織注釋:
- <summary></summary>
- <remarks></remarks >
- <param></param>
- <returns></returns>
- <newpara></newpara>
要在Visual Studio .NET中查看這些XML注釋的格式化的報告,我們可以首先選擇“工具”菜單項,然后選擇“建立注釋Web網頁”菜單項。
ASP.NET注釋使用的技巧就向大家介紹到這里,希望對你編程習慣的的養成有所幫助。
【編輯推薦】