// 文档名称 codetemplates.xml <?xml version="1.0" encoding="UTF-8" standalone="no"?> <templates> <template autoinsert="false" context="settercomment_context" deleted="false" descriptio…

这篇博客将要讨论的是关于: 如何从C#的source以及注释, 生成一份Word格式的关于各个类,函数以及成员变量的说明文档. 他的大背景如下...... 最近的一个项目使用C#, 分N个模块, 在项目的里程碑的时候, 日本的总公司要检查我们的成果物. 成果物包括源代码, 概要设计式样书(SD,System Design), 详细设计式样书(PD, Program Design), 自动化测试等等. 源代码必须要符合编码规范(每个函数都要有注释, 方法变量的命名规则等...) 这些检查都很正常,…

前言: 一般写完代码之后,还要将各类参数注解写入API文档,方便后续进行对接和测试,这个过程通常都很麻烦,如果有工具可以读取代码注释直接生成API文档的话,那会十分方便. 此前一直都是在使用eolinker的,但自从去年他们家"注释生成文档"的功能下线后,我就一直活在水深火热当中--真的不想写文档啊,真的好累啊. 然而这两天上线后,突然发现这个功能重新上线了!必须给大家安利一波! 官网地址:https://www.eolinker.com 根据官方的解释,这个功能简单来说就是读取 gi…

Visual Studio 2008(C#)XML注释提取成帮助文档的方法     1.给方法和类添加XML注释 可以手动添加,具体规则可以看MSDN:http://msdn.microsoft.com/zh-cn/library/b2s063f7(VS.80).aspx 这里介绍一个工具,可以帮助生成注释,下载地址:http://submain.com/products/ghostdoc.aspx 安装ghostdoc后,可以在右键和工具菜单中找到它: 把鼠标放到一个方法或类的里边,点击右键,…

http://hi.baidu.com/danghj/item/7625a1be20946e43ba0e1202在eclipse中使用中文JAVA api文档Sun 官方的中文版 Java API 文档发布了,地址为: http://gceclub.sun.com.cn/download/Java_Docs/html_zh_CN.zip  , 下载后请参考如下步骤配合 eclipse3.1 使用…

前言: 想要学好一门技术,最起码要对他有一定的了解,起码听说过相应的底层原理的东西吧,最起码你要有一点能和别人交流的内容吧,下面是我精简的一点内容,希望对于大家了解netty能有一点帮助 Netty是建立在NIO基础之上,Netty在NIO之上又提供了更高层次的抽象. 在Netty里面,Accept连接可以使用单独的线程池去处理,读写操作又是另外的线程池来处理. Accept连接和读写操作也可以使用同一个线程池来进行处理.而请求处理逻辑既可以使用单独的线程池进行处理,也可以跟放在读写线程一块处理…

快捷方式 方法注释的快捷键:ALT + SHIFT +J 格式化:Ctrl+Shift+F 把当前选中的文本全部变味大写:Ctrl+Shift+X 把当前选中的文本全部变为小写:Ctrl+Shift+Y 快速修复:Ctrl+1 重命名:Alt+Shift+R /F2 删除当前行 :Ctrl+D 抽取方法 :Alt+Shift+M 抽取局部变量 :Alt+Shift+L 复制当前行到下一行:Ctrl+Alt+↓ 复制当前行到上一行:Ctrl+Alt+↑ 定位在某行:Ctrl+L 字符编码 设置工作…

由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…

今日给合作公司讲解本公司网站SEO优化整理的一份简单文档 架构 ########################################## 1.尽量避免Javascript和flash导航. 虽然JS和FLASH能把网站做的绚丽漂亮,但目前搜索引擎还是无法顺利的抓取其中的内容,所以我们要避免. 2.目录层次不能太深. 网站目录尽量保持在三层以内,尽可能接近根网址,比如“www.xxx.com/产品目录/产品名称”明显比“www.xxx.com/产品目录/年份/月份/产品名称”要好. 3…

1.到官方网站去下载spring-framework的jar包 spring-framework jar包的下载地址是:http://repo.spring.io/release/org/springframework/spring/ 2.创建新的User Library Window->Pereferences->Java->Build Path->User Libraries.单击“new",新建一个新的User Library,命令为“spring-framewor…

一.摘要 在本系列的第一篇文章介绍了.NET中XML注释的用途, 本篇文章将讲解如何使用XML注释生成与MSDN一样的帮助文件.主要介绍NDoc的继承者:SandCastle. 二.背景 要生成帮助文件,很多人会想到NDoc.其实在VS2003中不使用NDoc也一样具有"生成Web文档"的功能.然而很不幸,在升级为VS2005和VS2008后, Visual Studio中的此功能已经取消. 更遗憾的是NDoc这个项目由于资金等问题,作者Kevin于2006年7月宣布不再投入NDoc开…

由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法 环境:vs2010 先下载安装Sandcastle 和Sandcastle Help File Builder 下载地址 http://sandcastle.codeplex.com/ http://shfb.codeplex.com/ 其中Sandcastle Help File Builder安装较复杂,安装红框内的即可 安装完成后,然后让要使用的项目输出xml…

示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * @author *** * @version 1.0 */ public class Person { /** * 这个是Person类的构造方法 * @param name Person 的名字 * */ public Person(String name) { //执行语句: } /** * 这是read…

一.摘要 在本系列的第一篇文章介绍了.NET中XML注释的用途, 本篇文章将讲解如何使用XML注释生成与MSDN一样的帮助文件.主要介绍NDoc的继承者:SandCastle. 二.背景 要生成帮助文件,很多人会想到NDoc.其实在VS2003中不使用NDoc也一样具有"生成Web文档"的功能.然而很不幸,在升级为VS2005和VS2008后, Visual Studio中的此功能已经取消. 更遗憾的是NDoc这个项目由于资金等问题,作者Kevin于2006年7月宣布不再投入NDoc开…

实际上该方法适合于所有版本的Visual studio,方法很简单,设置一下Visual studio的项目属性和工具选项即可. 1.在菜单栏的“Project”中选择当前项目的“*** Properties”,然后在“Build”标签页中找到“Output”一栏,在“XML documentation files”复选框中打上勾勾,在自定义输出的XML文档的文件名即可. 2.检查菜单栏上的“Tools”中选择“Options”菜单项,然后在“Text Editor”支点中找到“C#”,在其子项…

由于最近需要把以前的一个项目写一个文档,但一时又不知道写成怎样的,又恰好发现了可以生成chm的工具,于是乎我就研究了下,感觉还不错,所以也给大家分享下.好了,不多废话,下面就来实现一下吧. 生成前的准备 在开始做之前,还是要补充说明一点:我们是通过C#文档注释生成的XML文件来生成帮助文档的.因此,第一步就是生成XML文档: 具体步骤:打开VS->随意创建一个项目(这里我用的是控制台项目),然后添加如下内容: /// <summary> /// 人类 /// </summary&g…

# java语法基础 ## 标识符,关键字与注释 ### 标识符 1.类名,变量名,方法名都称为标识符. 2.命名规则:(1):所有的标识符都应该以字母(AZ,或者az)美元符($)或者下划线(_)开始. ​ (2):首字符之后可以是任意字符的组合. ​ (3):关键字不能用作标识符. ​ (4):标识符的大小写是敏感的. 3.标识符样例 | | | | | | | | ## 关键字 | | | | 1.关键字是有特定意义的系统预定义保留的标识符. | | 2.java中常见的关键字 | | |…

1:jQuery的API和jquery.js和jquery.min.js 链接:http://pan.baidu.com/s/1gf7GD83 密码:tbt1 2:虚拟机软件和frdora和ubuntu镜像 链接:http://pan.baidu.com/s/1cvF8fG 密码:lf4e 3:MyEclipse的破解版和jdk 链接:http://pan.baidu.com/s/1boHHXMZ 密码:txgj 4:SVN的客户端和服务器端 链接:http://pan.baidu.com/s/…

源代码 Source 按住 Ctrl 键,鼠标放到对应的类.方法上,出现 Open Declaration,Open Implementation ,可查看对应的实现.声明源代码. 也可以在[Project Explorer]视图中,Libraries 下找到相应的类,打开即可查看源代码. 如果没有源代码,则会出现 "Source not found",[Attach Source...]按钮可配置. 也可以在 [Project Explorer]视图中,对应项目的 "Jav…

…

1. primary shard   -- raid0 2.replicas shard -- raid1 3.index -- 图书馆的借书指引 4.MySQL vs elasticsearch ######################################################################## 1. curl GET http://10.0.0.92:9200/_cluster/health?level=indices "cluster_name&…

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.…

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.…

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */…

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */ 2.…

关于快捷键 Eclipse 的很多操作都提供了快捷键功能,我们可以通过键盘就能很好的控制 Eclipse 各个功能: 一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行…

IDEA查看类 成员变量  局部变量注释快捷键,Ctrl +Q 查看帮助文档 实际项目中,通常一个类中的代码都不少,而且有很多的变量 那么如何快速知道这个变量的一些信息,比如类型,定义? 比如在第500行有一个变量,可能他是定义在第100行,可以直接 Ctrl+鼠标左键,点击,这个应该都知道 可以快速的跳转到定义的地方 另外还有一个快捷键,可以查看方法或者变量的一些信息 第一步,移动光标至想要查看的变量或者方法上 第二步,Ctrl+Q 效果如下图所示 1.)toString方法上操作…

整理文档时,我们可能会需要在一些或一段文字上添加注释加以说明,那如何以编程的方式实现呢?本文将实例讲述C#中如何使用免费组件给PDF文档添加文本注释,包括自由文本注释.自由文本注释能允许我们自定义它的风格和外观,非常具有实用价值. 首先,下载这个免费版组件Free Spire.PDF.组件下载安装后,Visual Studio创建C#控制台项目,添加bin文件夹的.DLL作为引用以及以下命名空间: using System; using System.Drawing; using System.…

1.1      文档注释导出帮助文档 在eclipse使用时,可以配合文档注释,导出对类的说明文档,从而供其他人阅读学习与使用. 通过使用文档注释,将类或者方法进行注释用@简单标注基本信息.如@author 作者.@version代码版本.@param方法参数.@return方法返回值等. package cn.itcast; /** * 我的工具类 * @author Li * @version 1.0版本 */ public class Tool { /** * 返回两个整数的累加和 *…