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

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

　　由於對程式碼的註釋很多人都有不同見解，包括前段時間，部落格園新聞裡面有篇文章，大概意思是說有註釋，說明本身程式碼就很爛，所以用註釋來補充。當然我並不認同這種觀點，雖然也有一點點道理。

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

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 model
4 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的例項程式碼