- 浏览: 724753 次
- 性别:
- 来自: 北京
文章分类
- 全部博客 (1081)
- [网站分类]1.首页原创精华.NET区(包含架构设计、设计模式)(对首页文章的要求:原创、高质量、经过认真思考并精心写作) (0)
- [网站分类]2..NET新手区(用于发表不合适发表在首页的.NET技术文章,包括小经验、小技巧) (1)
- [网站分类]3.非技术区(技术之外的文章,但不要涉及任何政治内容) (0)
- [网站分类]4.其他技术区 (0)
- [网站分类]5.企业信息化 (0)
- [网站分类]6.读书心得区(技术书籍阅读心得、书籍推荐) (0)
- [网站分类]7.提问区(.NET技术方面的提问) (2)
- [网站分类]8.技术转载区(.NET技术文章转载, 请注明原文出处) (0)
- [网站分类]9.求职招聘区(个人求职、企业招聘) (0)
- [网站分类]Dottext区 (0)
- [网站分类]GIS技术 (0)
- [网站分类]IT英才专区(IT职场交流) (0)
- [网站分类]SharePoint (0)
- [网站分类]博客园.NET俱乐部(俱乐部组织与活动方面的文章) (0)
- [网站分类]软件发布区(发布自己开发的代码、软件) (0)
- [网站分类]网站管理区(网站管理方面的疑问、建议、意见, 寻求管理员帮助) (0)
- [网站分类]业界新闻 (1)
- 技术 (1)
- [随笔分类]生活感悟 (10)
- [随笔分类]C# (30)
- [随笔分类]AjaxPro教程 (3)
- [发布至博客园首页] (5)
- [随笔分类]简历 (0)
- [随笔分类]Linux (2)
- [随笔分类]技术聚会 (2)
- [随笔分类]ORM (1)
- [随笔分类]php (1)
- [随笔分类]创业 (1)
- [随笔分类]奇技淫巧 (1)
- [随笔分类]计划 (1)
- [随笔分类]架构&分层 (1)
- [随笔分类]整合行销 (1)
- [随笔分类]mac (1)
- [网站分类].NET新手区 (45)
- [网站分类]非技术区 (5)
- [网站分类]招聘区 (0)
- [随笔分类]单元测试 (1)
- [网站分类]其他技术区 (3)
- [网站分类]代码与软件发布 (6)
- [网站分类]提问区 (24)
- [随笔分类]ASP.NET (2)
- [随笔分类]FAQ (12)
- [随笔分类]开发人员工具 (1)
- [随笔分类]朗志轻量级项目管理解决方案 (1)
- [网站分类]读书区 (1)
最新评论
-
天使建站:
写和乱七八糟的 不知道从哪复制过来的 还是看这里吧j ...
jquery数组 -
hyn450:
你好,我最近也想了解一下竞争情报。不知道能不能交流一下呢 ?
最近的工作 -
lattimore:
这个连接打不开了阿!
使用vnc连ubuntu desktop -
MZhangShao:
奉劝你一句,以后在Ubuntu 用apt-get安装成功的软件 ...
关于xrdp的安装设置 -
f002489:
strftime
python下datetime类型的转换
目录
1、GhostDoc1.2.1简介
GhostDoc 是一个基于Visual Studio的 XML 文档注释生成器,相比 NDoc 而言它更可以帮助你自动生成大量令人厌烦的相似的描述。
2、安装(for VS2005)
在安装之前请确保关闭Visual Studio2005,双击GhostDoc2.1.1.msi进行安装
点击"Next":
选 "I Agree" 点击"Next":
选择要安装的路径,点击"Next":
点击"Next"开始安装:
安装完成之后,出现如下图的窗口,点击"Close"完成安装:
3、配置
2.1、初步设置
打开Visual Studio 2005,出现如图对话框,如下图:
在此可以设置热键,点击"Assign",如果还不知道要把热键设成什么,或者要设的热键不在下拉菜单中,点击"Skip",之后再设。这里点击"Skip",如下图:
如果是第一次安装GhostDoc,点击"Create";如果要载入已有的结构,点击"Import"(此处点击"Create")。出现如下窗口:
点击"Finish"完成,进入Visual Studio 2005界面,如下图:
在"工具"的下拉菜单里就会出现一个"GhostDoc"的选项,如下图:
右键菜单中就会出现"Document this"命令,如下图:
2.2、GhostDoc的配置
在Visual Studio2005的菜单栏中选择"工具|GhostDoc|Configure GhostDoc",弹出对话框如下图:
其中包含的属性页:
1. Rules 修改,删除,添加文本生成规则
2. Acronyms 指定将哪些单词视为首字母缩写词
3. "of the"Reordering 指定触发重新排序行为的单词
4. "No the"Words 指定哪些词前不使用"the"
5. Options 配置GhostDoc的其他选项
2.3、热键的设置
打开Visual Studio 2005的"工具|选项",如下图:
在弹出的对话框的左边框中选择"环境|键盘",如下图:
在右侧键盘定义区的"显示命令包含(C):"下的输入栏里输入"ghost",如下图:
在"新快捷键用于(N):"中选择"文本编辑器",并在其后的"按快捷键(P):"中按所要设置的快捷键(这里设成Ctrl+Shift+D),如下图:
点击"分配",再点击"确定"完成,如下图:
4、使用GhostDoc为代码生成注释
GhostDoc为Visual Studio中的代码编辑器安装了一个新的命令。在编辑文件时,只需将光标置于要添加文档的方法或属性的内部,然后使用热键(初始化时默认是Ctrl+Shift+D)或右键菜单中的"Document this"菜单项调用命令,GhostDoc就会插入一段XML格式的注释。
这里用GhostDoc自带的一个Demo代码作介绍(双击与安装文件同一目录下的GhostDoc2.1.1DemoProject.msi,安装过程与"1 安装" 一样,安装完成后就会在"开始|所有程序|Weigelt|GhostDoc for VS 2005"目录下会出现一个"Open Demo C# Project" 选项,如下图:
)
打开"Open Demo C# Project",如下图:
将光标置于要添加文档的方法或属性的内部(注意,必须是内部),比如要注释Demo中的FullFileName方法,需将光标置于FullFileName方法的"{……}"中或方法名上,如下图:
然后使用热键(初始化时默认是Ctrl+Shift+D,如果初始化没设,可参考下文的设置)或右键菜单中的"Document this"菜单项调用命令,GhostDoc就会插入一段XML格式的注释,如下图:
当然,在方法或属性前面键入"///"也可以达到类似的效果,如下图给JustTesting方法注释:
然而后者只能够创建一段空的注释构造,而GhostDoc却能生成大部分实用的注释,如下图比较:
需要注意的是:GhostDoc生成注释的质量很大程度上取决与标识符命名的质量;而且GhostDoc也不能一次性为整个代码文件生成注释,只能每次为一个成员生成注释—如此设计是因为不管怎么样都需要你去检查它生成的每一段注释。
4、代码注释规范
GhostDoc事实上并不懂英语,那为何它生成的文档却常常令人相当满意?其中的基本原理颇为简单,GhostDoc假定你的代码遵从微软类库开发人员设计规范:
1、你的代码使用Pascal或Camel命名法为由多个单词组成的标识符命名
2、你的方法名通常以动词开头
3、你在标识符中不使用缩写
如果你能够遵从这些规则(比如,使用ClearCache()而不是Clrcch()),同时使用一些自解释的标识符名称,那么GhostDoc就能派上用场了,它把标识符分割为几个单词,将它们组合来生成注释,也许并不完美,却给你一个良好文档的开始。
文本的生成使用可定制的规则和模板,除了内置的规则,还可以定义新的自定义规则来扩展或替换既有的规则(为你的自定义规则提供更高的优先级或禁用内置规则)。
上面提到过,GhostDoc并不懂英语,但它会尝试使用某种机制来提高生成注释的质量:
1、动词的处理机制(GhostDoc假定方法名的首个单词为动词):Add->Adds,Do->Does,Specify->Specifies;
2、"Of the"排序组织机制:ColumnWidth –> Width of the column.
3、 一些特殊形容词的特殊合并机制:例如,MaximumColumnWidth->Maximum
width of the column而不是Width of the maximum column
4、 对首字母缩写组成的常量的自动检测,并通过一个列表来处理其它的一些首字母缩写术语
5、 使用一个单词列表,以决定何时不使用"the":AddItem ->Adds the item, BuildFromScratch ->Builds from scratch
下面是应用GhostDoc的一些例子:
是不是惊人的准确啊!!!
发表评论
-
关于分层架构中的业务实体层的使用一直不太清楚,可否指点一下?
2007-03-23 09:10 671我知道业务逻辑层又可细分为三个层次,分别是业务外观层业务规则层 ... -
xml反串行化
2007-07-02 17:23 7321using System; 2using Syste ... -
WriteXmlSchema(xsdFileName)和GetXmlSchema()输出的内容的差异
2007-07-04 19:00 881利用DataSet.ReadXml载入一个xml文件,再使用G ... -
对websharp中aspect的改进(待续)
2007-11-17 14:27 692缘起 为了在我的《朗志轻量级项目管理解决方案》项目中应用 ... -
WebSharp Aspect改进(续2)
2007-11-19 21:39 700接着上次在《朗志轻量级项目管理解决方案》中对Aspec ... -
TreeView(树形控件)中常用到的属性和事件
2007-11-19 22:22 12941.TreeView(树形控件) ... -
有没有适合的的面向对象的查询语言(Object Query Language)
2007-11-28 10:15 759在我做《朗志轻量级项目管理解决方案》的过程中,我希望 ... -
问题解答集
2007-11-29 18:11 4401 如何在源代码的目录下添加一个测试文件 ... -
FckEditor自定义按钮
2007-11-29 18:35 829目录 FckEditor自定义按钮 1 目录 ... -
Log4net使用说明
2007-11-29 18:44 785Log4net使用说明 1 修改历史纪录 ... -
MySQLHelper类使用说明
2007-11-29 18:46 1314目录 MySQLHelper类使用说明 1 目录 ... -
NDoc1.3.1使用手册
2007-11-29 18:47 764目录 NDoc1.3.1使用手册 1 目录 ... -
程序中操作Word
2007-11-29 18:52 727目录 程序中操作Word 1 目录 2 ... -
利用SMTP服务发送电子邮件
2007-11-29 18:58 1352目录 利用SMTP服务发送电子邮件 1 目录 ... -
程序中操作Excel
2007-11-29 18:59 637目录 程序中操作Excel 1 目录 ... -
访问被拒绝:“AjaxPro”的解决方案
2007-11-29 19:01 531目录 访问被拒绝:&qu ... -
sqlserver的版本号
2008-02-27 21:01 819当你安装了sqlserver 2005之后你就可以使用sqls ... -
在安装有VS2008beta2版本的机子上使用vs2005进行部署出现问题的解决方法
2008-02-27 21:13 679我知道,2008rtm发布已经很久了,不巧的是同学在我的机子上 ... -
忙话codesmith
2008-07-28 15:01 865为什么不是闲话,因为我很忙,项目中新问题是接连不断,上一篇讲到 ... -
Berkeley Db Associate关联数据函数的使用
2008-07-31 21:42 836Code<!--<br /><br ...
相关推荐
中文手册的发布使得国内开发者可以更加便捷地理解和使用CodeIgniter,避免了语言障碍带来的困扰。 在CodeIgniter 2.1.1中文手册中,你可以找到关于以下核心概念和功能的详细解释: 1. **安装与设置**:手册首先...
先临三维扫描仪v2.1.1用户手册.pdf
1. 安锐通模组使用手册 安锐通科技有限公司发行的模组使用手册,主要面向使用安锐通提供的38x38尺寸模组的用户。手册提供了详细的操作指南,包括了对模组的安装、配置以及功能使用等。 2. 视频通话与监控功能 ...
微软提供的jquery-2.1.1.intellisense.js文件需要jquery-2.1.1.min.js或jquery-2.1.1.js的配合才能使VS进行智能提示,这使得jquery-2.1.1-vsdoc.js文件在asp.net mvc开发中使用了ScriptBundle功能后变得尤为重要。...
phantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-windowsphantomjs-2.1.1-...
Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V2.1.1.rplib Axhub Charts Pro V...
apache-hive-2.1.1-bin.tar apache-hive-2.1.1-bin.tar apache-hive-2.1.1-bin.tarapache-hive-2.1.1-bin.tar apache-hive-2.1.1-bin.tar apache-hive-2.1.1-bin.tarapache-hive-2.1.1-bin.tar apache-hive-2.1.1-...
Hive是Apache Hadoop生态系统中的一个数据仓库工具,它允许用户使用SQL(称为HQL,Hive Query Language)对存储在HDFS上的大型数据集进行分析。Hive 2.1.1是Hive的一个重要版本,而CDH6.3.2是Cloudera发行的商业版...
开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发工具 commons-dbcp2-2.1.1开发...
标题 "hive2.1.1 + hadoop2.6.0 jdbc驱动" 指的是一个包含特定版本的Hive和Hadoop组件的集合,这些组件特别针对通过JDBC进行数据库连接进行了优化。Hive是Apache软件基金会开发的一个数据仓库工具,它允许用户使用...
该资源为numpy-2.1.1.tar.gz,欢迎下载使用哦!
原因可能在于这个版本可能存在与HCL V2.1.1不兼容的问题,或者为了确保最佳性能和稳定性,开发者推荐使用特定的VirtualBox版本。因此,我们应当使用压缩包中提供的VirtualBox-5.2.22-126460-Win.exe来进行安装。 在...
* SuperSlide v2.1.1 * 轻松解决网站大部分特效展示问题 * 详尽信息请看官网:http://www.SuperSlide2.com/ * * Copyright 2011-2013, 大话主席 * * 请尊重原创,保留头部版权 * 在保留版权的前提下可应用...
而对于Linux用户,他们将使用"phantomjs-2.1.1-linux-x86_64.tar.bz2",这是一个针对64位Linux系统的tar.bz2压缩包,用户需要先解压,然后将可执行文件添加到PATH环境变量中以便全局调用。 标签中包含"phantomjs"和...
文件包含: nacos-server-2.1.1.tar.gz nacos-server-2.1.1.zip nacos-server-2.1.1Source code(zip) nacos-server-2.1.1Source code(tar.gz)
在Windows环境下安装和使用Nacos2.1.1版本,你需要了解以下几个关键知识点: 1. **下载与解压**:首先,你需要从官方或可靠的源下载Nacos2.1.1的Windows版本压缩包。下载完成后,将其解压到本地文件夹,通常包含`...
同时,手册也明确了产品的使用风险,如网络攻击、数据丢失等,并指出产品按照现状提供,不提供特定保证。用户在使用产品时,需遵守相关法律法规,防止不当使用带来的法律责任。 手册的前言部分提示用户在使用前详细...
“免费远程桌面软件RDC2.1.1”表明这是一个无需付费的解决方案,用户可以免费下载和使用,这对于个人用户和小型企业来说特别有吸引力,因为它们可能没有足够的预算购买和维护昂贵的远程访问软件。 描述中提到,这款...
使用Unlocker Master v2.1.1的过程一般包括以下步骤: 1. **下载与安装**:首先,用户需要从可靠的源获取Unlocker Master v2.1.1的压缩包文件,并解压到本地目录。 2. **环境准备**:确保已经安装了VMware ...
VisualSVN Server 2.1.1是一款专为Windows平台设计的Subversion(SVN)服务器,它使得在企业环境中部署和管理版本控制系统变得简单易行。Subversion是一种开源的版本控制系统,用于跟踪文件和目录的修改历史,是软件...