sandcastle 為你的程式產生說明文件

每次比較大的案件要結案時客戶總是會要求一些程式說明文件，這個是很讓人頭痛的尤其是很喜歡改來改去的客戶，到最後根本沒辦法依照當初規劃的文件去產生程式說明。

sandcastle這個軟體可以產生chm和html檔的說明文件，最主要是在程式撰寫時必須在每個class中寫好註解如下
 
///

/// bank 的摘要描述
///

public class bank : IDisposable{

    ///

    /// 新增銀行資訊
    ///

   
    /// 銀行代碼
    /// 銀行名稱
    /// int
    public int add(string code, string bankname)
    {
     ..................
    }
     ...................

}

接下來在.net的指令模式下執行下列指令產生xml文件
C:\文件要產生的路徑>csc  /doc:bank.xml /recurse:App_Code\*.cs  /reference:Bin\NPOI.dll,BIN\Ionic.Zip.dll,Bin\DocX.dll,Bin\AntiXSSLibrary.dll

產生出來的xml再利用sandcastle軟體產生說明文件即可，下面的global項目要勾選才會產生所有class的說明文件哦

參考資料
http://msdn.microsoft.com/en-us/library/ms379563%28v=vs.80%29.aspx
http://sandcastle.codeplex.com/