原為地址:http://blog.sina.com.cn/lsy835375

C#程式碼註釋規範及文件生成 在使用c#進行Unity3D遊戲開發中，良好的註釋和文件能讓開發更有效率，條理更清晰。 本講分為兩個部分： 一：編寫註釋 二: 生成文件                          編寫註釋 開發註釋是 // 幫助拓展程式碼
使用註釋是 /// 幫助使用程式碼 開發註釋：輔助開發，對變數或者函式等程式碼的後續開發做的註釋。 例如，你定義了一個私有變數 private int coins; 不打算讓外部訪問該變數。但在開發過程中，需要一些提示。 //金幣的數量 private int coins;  使用註釋：幫助使用，主要是對使用變數或函式等程式碼的使用呼叫做的註釋。 例如上面的coins變數，我們打算讓外部能訪問。那麼程式碼是public int coins; 在這段程式碼前輸入/// 則Mono會自動根據變數名生成如下注釋，summary是對下方程式碼的總結

1. /// <</span>summary>
2. /// The coins.
3. /// </<span>summary>
4. public int coins;

之後你可以自己添加註釋如

1. /// <</span>summary>
2. /// 金幣總數
3. /// </<span>summary>
4. public int coins;

或者按行輸入文字， 代表一行

1. /// <</span>summary>
2. /// <<span>para>金幣數</<span>para>
3. /// <<span>para>可以當錢花</<span>para>
4. /// </<span>summary>
5. public int coins;

函式也是同樣的寫法。 有函式如下

1. public void UseCoins(int number)
2. {
3. }

在函式前輸入///  , 得到如下，其中 <</span>param

name='number'> 代表一個引數

1. /// <</span>summary>
2. /// Uses the coins.
3. /// </<span>summary>
4. /// <<span>param name='number'>
5. /// Number.
6. /// </<span>param>
7. public void UseCoins(int number)
8. {
9. }

這麼寫的好處是： 1.呼叫時彈出註釋，如下

2.能根據該格式的註釋自動生成文件                       生成文件 當代碼按上面介紹的///格式寫了註釋後，就可以自動生成文件了。這兩天，風宇衝尋找最佳方生成Unity3d程式碼幫助文件的方法。 嘗試了3種方法：
(1)Mono:Mono提供的方法步驟太繁瑣,還要敲指令。放棄。
(2)Visual Studio + Sandcastle Help File Builder
這個方法還算可以，步驟稍麻煩，而且Sandcastle Help File Builder缺點比較多，如類必須在名稱空間裡（unity3d 4.0以上才支援MonoBehaviour的繼承函式放在名稱空間裡），慢，功能不完善等。
做法：
 把程式碼和UnityEngine.dll等庫拖進Visual Studio,然後用VS build。
 之後用Sandcastle Help File Builder載入生成的XML，生成文件。
(3)Doxgen: 支援圖表，類可以不在名稱空間裡。不支援js。跨平臺。
最後，風宇衝找到了最適合Unity3d的文件生成工具 - Doxgen。

Doxgen使用方法

下載後開啟，
(1)設定如下圖


(2)設定圖表如下。



(3)去掉路徑字首。（該路徑會顯示在文件頁面的左下角）
例：
程式碼路徑  D:\My Documents\namespaceTest\Assets\scripts\GUI
則裁剪路徑填 D:/My Documents/namespaceTest/Assets/scripts


(4)生成文件。
(5)檢視文件。 可以點選按鈕Show HTML output按鈕，或者直接開啟本地網頁 儲存的資料夾->html資料夾->index.html


(6)最後 點選File->Save 儲存配置檔案。該檔案可以用來讀取配置，也可以跨平臺使用。

PS:MAC的osx系統下，Doxygen的使用方法類似

最終效果：

PS: 如果想要生成更好的好關係圖 (1)下載Graphviz  http://www.graphviz.org/ (2)安裝後指定graphviz的Dot路徑

(3)指定
Html資料夾用起來不方便，還可以轉Chm文件，這裡用的是HugeChm