你用過(guò)這種奇葩的C#注釋嗎？如何看待

2015-04-20 11:19:15

本人雖然不是專業(yè)開(kāi)發(fā)人員，也非專業(yè)出身，但一直使用C#堆碼，解決自己日常的小問(wèn)題。包括自己的研究，也是用C#來(lái)實(shí)現(xiàn)和測(cè)試。對(duì)C#是情有獨(dú) 鐘。雖然C#的很多高級(jí)技術(shù)不會(huì)用，也不太懂，但總歸是知道，耳聞目染，都多多少少了解一點(diǎn)。因?yàn)檠芯块_(kāi)源組件和技術(shù)比較多的原因，經(jīng)常翻別人的代碼（大部分是國(guó)外的），免不了要翻譯，所以我也是經(jīng)常翻譯和總結(jié)，例如我前2個(gè)翻譯的一些機(jī)器學(xué)習(xí)的文章：

【原創(chuàng)】.NET平臺(tái)機(jī)器學(xué)習(xí)組件-Infer.NET連載(一)介紹

【原創(chuàng)】.NET平臺(tái)機(jī)器學(xué)習(xí)組件-Infer.NET連載(二)貝葉斯分類器

其實(shí)翻譯一直在進(jìn)行，也完成很多了，但還沒(méi)有時(shí)間整理和發(fā)表上來(lái)給大家分享。但是前不久在看代碼（也是翻譯的一部分）過(guò)程中，發(fā)現(xiàn)了一個(gè)非常奇葩的注釋，所以順手就搜索引擎翻了翻，總結(jié)一下，同時(shí)大家也談?wù)勅绾慰创@種寫法。

由于對(duì)代碼的注釋很多人都有不同見(jiàn)解，包括前段時(shí)間，博客園新聞里面有篇文章，大概意思是說(shuō)有注釋，說(shuō)明本身代碼就很爛，所以用注釋來(lái)補(bǔ)充。當(dāng)然我并不認(rèn)同這種觀點(diǎn)，雖然也有一點(diǎn)點(diǎn)道理。

聲明：有可能本人見(jiàn)識(shí)比較少，可能很多人見(jiàn)過(guò)，也用過(guò)，我第一次見(jiàn)到，反正有點(diǎn)震驚，當(dāng)然肯定是符合語(yǔ)法要求的，所以寫出來(lái)，請(qǐng)輕拍。

1.C#的注釋方式

搞C#的人應(yīng)該都清楚，C#有3種標(biāo)識(shí)注釋的方式：

1.1 三斜杠(///)方式

一般用于類或者方法的前面，如下面的代碼：

/// <summary> 
 
/// 這里是注釋。。。。。 
 
/// Latent Dirichlet Allocation (LDA) model implemented in Infer.NET. 
 
/// This version scales with number of documents. 
 
/// </summary>

1.2 雙斜杠(//)方式

一般是對(duì)臨時(shí)變量，屬性等的注釋，當(dāng)然也可以用在類或者方法前面，反正都是注釋，如下面的代碼：

1 //---------------------------------------------  
2 // The model 
4 Range D = new Range(NumDocuments).Named("D");

1.3 塊注釋(/*XXXX*/)方式

一般用于一段連續(xù)的注釋代碼塊，如下面的代碼：

/* 這段程序已經(jīng)不再有用 
* 因?yàn)槲覀儼l(fā)現(xiàn)千年蟲(chóng)問(wèn)題只是一場(chǎng)虛驚 
* 我們的系統(tǒng)不會(huì)恢復(fù)到1/1/1900 
*/

我印象中，C#的注釋的標(biāo)識(shí)符應(yīng)該就是這3種把，當(dāng)然其他的一些注釋類型參數(shù)，我們不討論。

2.這樣注釋奇葩么？

上面三種注釋方式大家肯定都用過(guò)，估計(jì)也是和我一樣(大部分)，寫在類，屬性或者臨時(shí)變量前面，另起一行。

我這里說(shuō)的奇葩，并不是脫離三種方式，而是其注釋的位置，但是在瀏覽一段開(kāi)源的代碼的時(shí)候，發(fā)現(xiàn)了這個(gè)注釋，當(dāng)時(shí)吃驚，然后是思考，先看看：

上面一段代碼包括了前面提到的3種注釋方式，紅色框里面的就是我說(shuō)的奇葩注釋，用的是 /* */塊方式，寫在數(shù)組定義的中間，毫無(wú)疑問(wèn)，這肯定是可以運(yùn)行的。只是以前沒(méi)想到可以這樣，可能局限于自己的思維方式。

根據(jù)我的理解，開(kāi)發(fā)人員這樣注釋的目的，由于這段代碼的變量包含的信息量很大，這樣寫更加直接明了。但是否多余，也可以直接在變量上面進(jìn)行說(shuō)明？

反過(guò)來(lái)想一想，在一些很復(fù)雜的問(wèn)題中，變量的初始化可能非常復(fù)雜，這里的數(shù)組長(zhǎng)度是2，如果是20，那怎么辦？這樣寫優(yōu)勢(shì)就出來(lái)了，可以使得看代碼的人，一目了然。

又在一個(gè)地方發(fā)現(xiàn)了一段類似注釋的代碼，是這樣的：

3.對(duì)自己好用，那就用起來(lái)

剛開(kāi)始有點(diǎn)接受不了，為了這個(gè)事情，我回憶了自己很多寫過(guò)的代碼，還特意翻了翻，最終我覺(jué)得以后在自己的代碼中也可以逐步在合適的地方采用這種方式，一方面是由于以前沒(méi)想到可以這樣用，思維局限在哪里，習(xí)慣另起一行說(shuō)明；另一方面的確是有很多代碼需要這樣明了的注釋，可能自己的代碼和架構(gòu)能力不夠，在很多地方耦合很嚴(yán)重，不得不通過(guò)很多的注釋來(lái)表現(xiàn)自己的想法，而變量有特別多，像這種初始化的情況，的確是很很說(shuō)明，看看我修改后的一段代碼例子：

3.1 以前注釋方式

以前的一段代碼中，有一個(gè)固定的有限列表，是公司編號(hào)，但實(shí)際開(kāi)發(fā)的時(shí)候，經(jīng)常要知道對(duì)應(yīng)的名稱，當(dāng)然數(shù)據(jù)庫(kù)里面可以去查找，但代碼里面直接看不到，所以我這樣寫的：

//權(quán)威公司編號(hào)名稱(順序)："澳門","金寶博","立博","威廉希爾","偉德","10BET","bet 365","SNAI" 
static List<Int32> AuthCompanyIdList = new List<int>(){ 247, 250, 251, 252, 253, 1, 469, 179};

所以以前每次打開(kāi)的時(shí)候，有錯(cuò)誤或者手動(dòng)排查一些信息，對(duì)著編號(hào)去注釋找，雖然次數(shù)很少，但偶爾也要用到。所以看到上面的注釋方式后，修改了一下。

3.2 現(xiàn)在的注釋方式

修改后的代碼是這樣的，不是特意去改，是這樣改之后，我自己也覺(jué)得好多了，看到這個(gè)代碼就知道意思了。

internal static List<Int32> AuthCompanyIdList = new List<int>(){ 
 
                                      247/*澳門*/, 250/*金寶博*/, 
 
                                      251/*立博*/, 252/*威廉希爾*/, 253/*偉德*/, 1/*10BET*/, 
 
                                      469/*bet 365*/, 179 /*SNAI*/                 
 
　　　　　　　　};