C#中如何規(guī)范化注釋-創(chuàng)新互聯(lián)

注釋對于增加程序的易讀性和可維護(hù)性非常重要，同時(shí)在編程的過程中，也有助于程序員使其思路更加清晰，降低出現(xiàn)邏輯錯(cuò)誤的幾率。對于注釋的風(fēng)格，往往采取下面的策略。

成都創(chuàng)新互聯(lián)是一家專注于網(wǎng)站制作、成都做網(wǎng)站與策劃設(shè)計(jì),原州網(wǎng)站建設(shè)哪家好?成都創(chuàng)新互聯(lián)做網(wǎng)站,專注于網(wǎng)站建設(shè)10年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:原州等地區(qū)。原州做網(wǎng)站價(jià)格咨詢:18980820575

1．文件級注釋

文件級注釋在于說明整個(gè)代碼文件的功能，常常還包含作者信息、創(chuàng)建日期信息等，便于代碼的后期維護(hù)。一個(gè)典型的文件級注釋如下所示。

上面示例給出了一個(gè)較為典型的文件級注釋，讀者可以根據(jù)自身的情況，指定統(tǒng)一的注釋規(guī)范。

2．函數(shù)級注釋

函數(shù)級注釋用于說明某個(gè)函數(shù)具體完成的功能、輸入?yún)?shù)類型、輸出結(jié)果等信息，便于函數(shù)的調(diào)用。一個(gè)典型的函數(shù)級注釋如下所示。

VS.NET開發(fā)環(huán)境可以自動(dòng)生成這個(gè)風(fēng)格的函數(shù)注釋，只需要在方法前輸入"//"，VS.NET就自動(dòng)生成注釋框架，開發(fā)者只需要在相應(yīng)的地方填入相應(yīng)的值就可以了。

這種風(fēng)格的注釋還有其他優(yōu)點(diǎn)，即當(dāng)開發(fā)者使用這個(gè)方法時(shí)，VS.NET會給出提示信息。根據(jù)上面的例子，在使用SetInfomation方法時(shí)VS.NET給出的提示信息。

3．代碼功能塊級注釋

在邏輯嚴(yán)密的方法實(shí)現(xiàn)中，常常是一個(gè)代碼塊完成一個(gè)特定的子問題，稱這樣一個(gè)代碼塊為功能塊。對于函數(shù)的功能塊添加注釋可以理順整個(gè)函數(shù)的功能，尤其體現(xiàn)在行數(shù)較多的函數(shù)中。如下面的示例所示。

如上面的示例，代碼功能塊級的注釋往往可以注釋到這個(gè)功能塊的上面一行，而各個(gè)功能塊之前使用空行來分隔。有了這樣的功能塊注釋，整個(gè)函數(shù)的實(shí)現(xiàn)邏輯顯得更為清晰，便于從整體上把握函數(shù)的實(shí)現(xiàn)，避免在實(shí)現(xiàn)一些邏輯復(fù)雜的功能時(shí)出現(xiàn)混亂。

4．代碼行級注釋

除了上面3種注釋，還需要在代碼行上加必要的注釋以進(jìn)一步增強(qiáng)代碼的可讀性，當(dāng)然，并不需要在每一行上都加注釋，只需要在比較復(fù)雜的某些行上加以注釋即可。代碼行級的注釋往往加在本行的后面，如下所示。

創(chuàng)新互聯(lián)www.cdcxhl.cn，專業(yè)提供香港、美國云服務(wù)器，動(dòng)態(tài)BGP最優(yōu)骨干路由自動(dòng)選擇，持續(xù)穩(wěn)定高效的網(wǎng)絡(luò)助力業(yè)務(wù)部署。公司持有工信部辦法的idc、isp許可證， 機(jī)房獨(dú)有T級流量清洗系統(tǒng)配攻擊溯源，準(zhǔn)確進(jìn)行流量調(diào)度，確保服務(wù)器高可用性。佳節(jié)活動(dòng)現(xiàn)已開啟，新人活動(dòng)云服務(wù)器買多久送多久。

當(dāng)前文章：C#中如何規(guī)范化注釋-創(chuàng)新互聯(lián)
URL分享：http://muchs.cn/article42/dhgdhc.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供做網(wǎng)站、外貿(mào)建站、網(wǎng)站建設(shè)、電子商務(wù)、品牌網(wǎng)站建設(shè)、自適應(yīng)網(wǎng)站

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)