GhostDoc(注釋生成工具)使用方法


本文轉載:http://www.cnblogs.com/scottckt/archive/2011/07/13/2105055.html

 

一、說明

   
GhostDoc是一個注釋(<summary>)生成工具。下載地址為:http://submain.com/download/ghostdoc/。

 

   
GhostDoc有兩個版本,普通和專業版。我安裝了專業版發現要注冊,改用了普通版。當然專業版中提供了更多的功能,例如可以生成當前文件中的全部注釋,而普通版中沒有。本文安裝的版本為V3.0。

 

    安裝完成后,可以在VS2008中工具中看見GhostDoc選項。如下圖1。

 

 

 

二、使用

 

 

     在Vs中新建一個項目,我新建的是一個Web 項目。代碼如下:

 


namespace TestJs2
{
   
public partial class _Default : System.Web.UI.Page
    {
       
protected void Page_Load( object sender, EventArgs e)
        {
        }
    }
}

 

在Page_load方法上右鍵,點擊“Document This”。如上圖2。結果如下。GhostDoc會自動生成注釋。

 


namespace TestJs2
{
   
public partial class _Default : System.Web.UI.Page
    {
       
/// <summary>
       
/// Handles the Load event of the Page control.
       
/// </summary>
       
/// <param name="sender"> The source of the event. </param>
       
/// <param name="e"> The <see cref="System.EventArgs"/> instance containing the event data. </param>
        protected void Page_Load( object sender, EventArgs e)
        {
        }
    }
}

 

 

 

三、自定義注釋

 

    系統生成的注釋不一定是我們想要的。 我們需要自己定義注釋怎么辦?網上已有人寫了相關文章。這里轉載一下。

 

   
原文地址:http://www.cnblogs.com/hjf1223/archive/2006/03/02/341476.html

 

 

 

 

    使用GhostDoc可以幫我們生成比較完整規范的代碼注釋,如果變量命名規范的話,只需要按下Ctrl+Shift+D
(默認熱鍵),由它自動產生的注釋就已經完全可以很好地表達我們的創建方法或屬性的目的,而不需要我們手動去修改注釋了。除了這些以外,它的強大之處在於
它的可訂制性。我們完全可以通過規則定義定制我們需要的注釋說明。下面圖解如何定制注釋。
    在Vs 2005 Tools 菜單下打選擇 GhostDoc
的下一級菜單項打開 GhostDoc 配置面板

GhostDocConfiguration.jpg

    選擇Method (表示配置方法的注釋),單擊 Add
按鈕添加一個規則。在Name中輸入規則名稱。

GhostDocConfiguration1.jpg

    選擇summary字段,單擊在最后出現的按鈕配置注釋模板,在Template
Text中入你想加入的內容,在Available macros中可以選擇宏變量。配置好后,點Ok。

GhostDocConfiguration2.jpg

  下邊自己可以在程序中測試一下。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM