真实的国产乱ⅩXXX66竹夫人,五月香六月婷婷激情综合,亚洲日本VA一区二区三区,亚洲精品一区二区三区麻豆

成都創(chuàng)新互聯(lián)網(wǎng)站制作重慶分公司

C#中如何規(guī)范化注釋

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

成都創(chuàng)新互聯(lián)公司專業(yè)為企業(yè)提供衢江網(wǎng)站建設(shè)、衢江做網(wǎng)站、衢江網(wǎng)站設(shè)計(jì)、衢江網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁(yè)設(shè)計(jì)與制作、衢江企業(yè)網(wǎng)站模板建站服務(wù),10多年衢江做網(wǎng)站經(jīng)驗(yàn),不只是建網(wǎng)站,更提供有價(jià)值的思路和整體網(wǎng)絡(luò)服務(wù)。

1.文件級(jí)注釋

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

  C#中如何規(guī)范化注釋 

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

2.函數(shù)級(jí)注釋

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

  C#中如何規(guī)范化注釋 

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

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

3.代碼功能塊級(jí)注釋

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

  C#中如何規(guī)范化注釋 

 

  C#中如何規(guī)范化注釋  

 

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

4.代碼行級(jí)注釋

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

 

  C#中如何規(guī)范化注釋

文章標(biāo)題:C#中如何規(guī)范化注釋
文章轉(zhuǎn)載:http://weahome.cn/article/gjicdg.html

其他資訊

在線咨詢

微信咨詢

電話咨詢

028-86922220(工作日)

18980820575(7×24)

提交需求

返回頂部