[工具介紹]C#快速撰寫註解-GhostDoc

转自：http://www.dotblogs.com.tw/hatelove/archive/2008/12/31/6580.aspx

上次在瓶水相逢.Net大大的點部落亂晃挖寶時，果然挖到了個寶，

內容主要是介紹怎麼快速撰寫註解的小工具。

瓶水相逢大大的原文在這，增進撰寫註解速度的小套件 GhostDoc。

需要軟體文件說明與安裝檔的，可至GhostDoc官方網站。

重點說明：

1. 目前GhostDoc支援VS2003、VS2005、VS2008的C#(VB.NET果然是被排擠的 )
2. 可以自行修改註解產生的規則，自行增刪註解裡的<tag>與相關內容。
3. 用快速鍵產生註解內容，不會影響到原有tag的內容，且會統一註解樣式，最好用的地方，還是在參數名稱、個數、class或property、method、function名稱改變時，註解不需要手動改變，只需要按一下快速鍵，就會產生修改後的內容。
4. 請搭配Coding Rule的命名規則，(通常是 Camel 或是 Pascal 命名法)，所以終於懂為啥命名要盡量用全名，大小寫要區分清楚了。最好開發人員也都熟悉英文，這樣在產生XML helper文件，真的比原本的方式快上好幾倍。
5. 安裝完GhostDoc只需要1.16MB，而且GhostDoc免費！！！！！

 

 

MSDN magazine也有一部份相關的介紹。

這邊附上一張MSDN上的圖，諸位看官就知道多好用了。

說明：

當參數名稱為productName的時候，會自動產生<param name=”productName”>Name of the product.</param>。

當今天把參數名稱改為CustomerID的時候，原本的tag就會改變成<param name=”CustomerID”>The customer ID</param>。

 

另外一個例子，假設自訂的電話UserControl，類別名字叫做LMZA0400_TEL，新開一個property叫做Required，型態是boolean，

只需要按一下快速鍵(預設是Ctrl+Shift+D)，就會幫你產生相關的註解，如下圖：

    /// <summary>
    /// Gets or sets a value indicating whether this <see cref="UserControl_LMZA0400_TEL"/> is required.
    /// </summary>
    /// <value><c>true</c> if required; otherwise, <c>false</c>.</value>
    public bool Required
    {
        get 
        {
            return this.txtTELAREA.Required; 
        }
        set 
        {
            this.txtTELAREA.Required = value;
            this.txtTEL.Required = value;
        }
    }

 

 

 

 

好好研究，訂定一下註解的Rule，要求一下開發人員遵循MSDN上命名規則，相信對團隊開發上是相當有幫助的。