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

简介: 本文转载:http://www.cnblogs.com/scottckt/archive/2011/07/13/2105055.html   一、说明     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

  下边自己可以在程序中测试一下。
目录
相关文章
|
人工智能 小程序 前端开发
小程序模版|家政服务小程序源码
小程序模版|家政服务小程序源码
236 0
|
数据采集 JavaScript Windows
用nodejs脚本实现网站自动签到功能
有一个网站每天签到可以获取流量,之前每天都是自己打开网页登录然后手动点签到,但是如果连续7天没签到之前获取的所有流量都会清空。类似的需求会有很多,很多网站、应用也都会提供签到获取积分、金币、能量、饲料...其实用node脚本来实现每天自动签到很简单的
|
SQL 安全 IDE
SonarQube使用介绍
SonarQube使用介绍
3112 0
SonarQube使用介绍
|
SQL 机器学习/深度学习 人工智能
Python加载数据入库SqlServer报错问题总结(持续更新,欢迎补充)
博主开始实习了,公司要求转Python,此博客用于记录我入库所遇到的问题,欢迎大家补充解决方法和遇到其他问题!!!(评论区留言,我会加在博客里)
2393 0
|
数据采集 存储 中间件
Python进行网络爬虫:Scrapy框架的实践
【8月更文挑战第17天】网络爬虫是自动化程序,用于从互联网收集信息。Python凭借其丰富的库和框架成为构建爬虫的首选语言。Scrapy作为一款流行的开源框架,简化了爬虫开发过程。本文介绍如何使用Python和Scrapy构建简单爬虫:首先安装Scrapy,接着创建新项目并定义爬虫,指定起始URL和解析逻辑。运行爬虫可将数据保存为JSON文件或存储到数据库。此外,Scrapy支持高级功能如中间件定制、分布式爬取、动态页面渲染等。在实践中需遵循最佳规范,如尊重robots.txt协议、合理设置爬取速度等。通过本文,读者将掌握Scrapy基础并了解如何高效地进行网络数据采集。
|
安全 JavaScript PHP
URL百分号编码
URL百分号编码
|
数据采集 数据可视化 数据挖掘
如何利用Python中的Pandas库进行数据分析和可视化
Python的Pandas库是一种功能强大的工具,可以用于数据分析和处理。本文将介绍如何使用Pandas库进行数据分析和可视化,包括数据导入、清洗、转换以及基本的统计分析和图表绘制。通过学习本文,读者将能够掌握利用Python中的Pandas库进行高效数据处理和可视化的技能。
|
存储 API 开发者
深入剖析 Qt QMap:原理、应用与技巧
深入剖析 Qt QMap:原理、应用与技巧
2360 0
|
存储 缓存 负载均衡
分布式算法之一致性 Hash 算法
一致性哈希算法(Consistent Hashing)是一种分布式哈希算法,用于在分布式系统中解决节点动态变化带来的数据迁移问题。在一致性哈希算法中,哈希值的范围是一个环形空间,每个节点在环上占据一个位置,数据的哈希值也映射到环上,然后按照顺时针方向找到第一个节点,将数据存储在该节点上。当节点动态变化时,只需要对受影响的数据进行重新哈希,将其映射到新的节点上即可,无需对整个数据集进行重新分配。这种方式可以有效地减少数据迁移的开销,提高系统的可扩展性和稳定性。
778 0
分布式算法之一致性 Hash 算法
|
Linux iOS开发 MacOS
Mac用户注意了,你的sed命令...
Mac用户注意了,你的sed命令...