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

閱讀目錄

• 1.C#的注釋方式
• 2.這樣注釋奇葩么？
• 3.對自己好用，那就用起來
• 4.最后猜猜誰寫的

　　本人雖然不是專業開發人員，也非專業出身，但一直使用C#堆碼，解決自己日常的小問題。包括自己的研究，也是用C#來實現和測試。對C#是情有獨鐘。雖然C#的很多高級技術不會用，也不太懂，但總歸是知道，耳聞目染，都多多少少了解一點。因為研究開源組件和技術比較多的原因，經常翻別人的代碼（大部分是國外的），免不了要翻譯，所以我也是經常翻譯和總結，例如我前2個翻譯的一些機器學習的文章：

【原創】.NET平臺機器學習組件-Infer.NET連載(一)介紹

【原創】.NET平臺機器學習組件-Infer.NET連載(二)貝葉斯分類器

　　其實翻譯一直在進行，也完成很多了，但還沒有時間整理和發表上來給大家分享。但是前不久在看代碼（也是翻譯的一部分）過程中，發現了一個非常奇葩的注釋，所以順手就搜索引擎翻了翻，總結一下，同時大家也談談如何看待這種寫法。

　　由于對代碼的注釋很多人都有不同見解，包括前段時間，博客園新聞里面有篇文章，大概意思是說有注釋，說明本身代碼就很爛，所以用注釋來補充。當然我并不認同這種觀點，雖然也有一點點道理。

聲明：有可能本人見識比較少，可能很多人見過，也用過，我第一次見到，反正有點震驚，當然肯定是符合語法要求的，所以寫出來，請輕拍。

1.C#的注釋方式

　　搞C#的人應該都清楚，C#有3種標識注釋的方式：

1.1 三斜杠(///)方式

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

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

1.2 雙斜杠(//)方式

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

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

3.塊注釋(/*XXXX*/)方式

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

  /* 這段程序已經不再有用   * 因為我們發現千年蟲問題只是一場虛驚   * 我們的系統不會恢復到1/1/1900    */

　　我印象中，C#的注釋的標識符應該就是這3種把，當然其他的一些注釋類型參數，我們不討論。

2.這樣注釋奇葩么？

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

　　我這里說的奇葩，并不是脫離三種方式，而是其注釋的位置，但是在瀏覽一段開源的代碼的時候，發現了這個注釋，當時吃驚，然后是思考，先看看：

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

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

反過來想一想，在一些很復雜的問題中，變量的初始化可能非常復雜，這里的數組長度是2，如果是20，那怎么辦？這樣寫優勢就出來了，可以使得看代碼的人，一目了然。

又在一個地方發現了一段類似注釋的代碼，是這樣的：

3.對自己好用，那就用起來

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

3.1 以前注釋方式

　　以前的一段代碼中，有一個固定的有限列表，是公司編號，但實際開發的時候，經常要知道對應的名稱，當然數據庫里面可以去查找，但代碼里面直接看不到，所以我這樣寫的：

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

　　所以以前每次打開的時候，有錯誤或者手動排查一些信息，對著編號去注釋找，雖然次數很少，但偶爾也要用到。所以看到上面的注釋方式后，修改了一下。

3.2 現在的注釋方式

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

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

　　其實哪種都可以，重要的是你看得懂，方便看，所以如果你覺得有用，可以用上，覺得純屬無聊，那就跳過吐槽一下。

4.最后猜猜誰寫的

　　敲代碼應該是件輕松的事情，如果能把代碼寫得非常優雅，好懂，當然最好不過了。最后娛樂一下，猜猜這代碼來自哪里？

　　A：某商業機器學習算法軟件的.NET例子；

　　B：某國外開源機器學習算法的.NET實現博客例子；

　　C：微軟研究人員機器學習算法實現的例子；

　　D：Python開源社區一個機器學習算法py實現的.NET版本；

　　如何看待和這種注釋，各抒其見把。。。。也可能是我小題大作了把。。。了解，不斷改進細節，不斷進步把。。

下午揭曉答案。。。。

第一段代碼來自微軟劍橋研究院，是Infer.NET的一個Demo代碼

第二段代碼來自開源機器學習組件Accord.NET Framework的實例代碼