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