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
{
    publicpartialclass _Default : System.Web.UI.Page
    {
        protectedvoid Page_Load(object sender, EventArgs e)
        {
        }
    }
}

复制代码

在Page_load方法上右键,点击“Document This”。如上图2。结果如下。GhostDoc会自动生成注释。

namespace TestJs2
{
    publicpartialclass _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>
        protectedvoid Page_Load(object sender, EventArgs e)
        {
        }
    }
}

复制代码

三、自定义注释

    系统生成的注释不一定是我们想要的。 我们需要自己定义注释怎么办?网上已有人写了相关文章。这里转载一下。

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

巧用GhostDoc,实现自定义注释

    使用GhostDoc可以帮我们生成比较完整规范的代码注释,如果变量命名规范的话,只需要按下Ctrl+Shift+D (默认热键),由它自动产生的注释就已经完全可以很好地表达我们的创建方法或属性的目的,而不需要我们手动去修改注释了。除了这些以外,它的强大之处在于 它的可订制性。我们完全可以通过规则定义定制我们需要的注释说明。下面图解如何定制注释。     在Vs 2005 Tools 菜单下打选择 GhostDoc 的下一级菜单项打开 GhostDoc 配置面板

    选择Method (表示配置方法的注释),单击 Add 按钮添加一个规则。在Name中输入规则名称。

    选择summary字段,单击在最后出现的按钮配置注释模板,在Template Text中入你想加入的内容,在Available macros中可以选择宏变量。配置好后,点Ok。

  下边自己可以在程序中测试一下。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏小李刀刀的专栏

再战子域共享Cookie问题

昨天贾宁旨光临寒舍,吃过晚饭回来后就跟他聊天,后来又玩了一会儿《Black Hawk Down》对战,到了大概晚上11点多,开始继续尝试用 Response.C...

50550
来自专栏weixuqin 的专栏

Nginx 安装配置教程

p.p1 { margin: 0.0px 0.0px 0.0px 0.0px; font: 12.0px Helvetica; color: #454545 }...

20210
来自专栏七夜安全博客

What!!! so fast

不要以为我是标题党,真的是so fast。。。最近有个小项目的需要,使用golang写了个端口扫描工具,不得不说golang的效率确实比python快的太多了。...

9820
来自专栏杂烩

kafka-eagle1.1.9安装 原

源码地址https://github.com/smartloli/kafka-eagle

12110
来自专栏运维

Nagios监控linux服务器

Nagios监控linux服务器 一、客户端 安装所需的软件(nagios-plugins、nrpe) #wget http://prdownloads.sou...

17610
来自专栏张高兴的博客

张高兴的 UWP 开发笔记:应用内启动应用 (UWP Launch UWP)

36590
来自专栏跟着阿笨一起玩NET

sql转Linq的工具

这些天写Linq挺烦人的,就上网搜搜可有什么好的sql转Linq的工具,咦,马上就看上了Linqer。

56230
来自专栏草根专栏

用ASP.NET Core 2.1 建立规范的 REST API -- 保护API和其它

http://www.cnblogs.com/cgzl/p/9010978.html

14820
来自专栏蓝天

Linux开发环境第三方库规划

让工作变得有条理,不乱糟糟,即使存在大量的第三方,也有章可循。简而言之,就是要保持目录的干净(如/usr/local目录),保持文件的干净(如profile文...

18930
来自专栏浪淘沙

Redis学习笔记

    (*)前身:Memcached     (*)区别:支持持久化,RDB、AOF                 支持丰富的数据类型

14720

扫码关注云+社区

领取腾讯云代金券