eclipse代码注释的设置
2015-09-18 10:00
225 查看
/article/2984831.html
在-vmargs下加入:-Duser.name=你的名字
(2).块(block)注释:“/*……*/”
(3).文档注释:“/**……*/”
(4).javadoc注释标签语法
@author 对类的说明标明开发该类模块的作者
@version 对类的说明标明该类模块的版本
@see 对类、属性、方法的说明参考转向,也就是相关主题
@param 对方法的说明对方法中某参数的说明
@return 对方法的说明对方法返回值的说明
@exception 对方法的说明对方法可能抛出的异常进行说明
@return_type返回类型
@date 日期
@time时间
然后点击edit,就是所有需设置注释的元素。现就每一个元素逐一介绍:
点击edit后,在pattern里按“ctrl“+”/”键,选择要添加的种类,例如日期,作者、时间、返回类型等等……
设置好以后,会在上图的pattern下生成相应代码,如下图所示:
/**
*
类的描述
* @authoryourname
* @Time 2012-11-20 14:49:01
*
*/
注释的pattern:
/**
* @Description:${todo}
* @author:${user}
* @time:${date} ${time}
*/
* @Description: ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
暂时用不到
(4)构造函数标签(Constructor):
规范:
/**
*
构造方法的描述
* @param name
* 按钮的上显示的文字
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
*/
/**
*
为按钮添加颜色
*@param color
按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time 2012-11-20 15:02:29
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
* ${return_type}
* @exception:
* @author: ${user}
* @time:${date} ${time}
*/
(7)代表方法(Delegate Methods)标签:
1. eclipse用户名的设置:
在eclipse的安装路径下,打开eclipse.ini的配置文件,如下图:在-vmargs下加入:-Duser.name=你的名字
2. 注释格式以及各个主要简介
(1).单行(single-line)注释:“//……”(2).块(block)注释:“/*……*/”
(3).文档注释:“/**……*/”
(4).javadoc注释标签语法
@author 对类的说明标明开发该类模块的作者
@version 对类的说明标明该类模块的版本
@see 对类、属性、方法的说明参考转向,也就是相关主题
@param 对方法的说明对方法中某参数的说明
@return 对方法的说明对方法返回值的说明
@exception 对方法的说明对方法可能抛出的异常进行说明
@return_type返回类型
@date 日期
@time时间
3类、方法、重写方法等类型的注释添加
打来:Window->Preference->Java->Code Style->Code Template 然后展开Comments节点,选中你要添加注释的类型,然后点击edit,就是所有需设置注释的元素。现就每一个元素逐一介绍:
点击edit后,在pattern里按“ctrl“+”/”键,选择要添加的种类,例如日期,作者、时间、返回类型等等……
设置好以后,会在上图的pattern下生成相应代码,如下图所示:
(1)文件(Files)注释标签:
目前没有用到,可以不用设置。(2)类型(Types)注释标签(类的注释):
规范:/**
*
类的描述
* @authoryourname
* @Time 2012-11-20 14:49:01
*
*/
注释的pattern:
/**
* @Description:${todo}
* @author:${user}
* @time:${date} ${time}
*/
(3)字段(Fields)注释标签:
/*** @Description: ${field} : ${todo}(用一句话描述这个变量表示什么)
*/
暂时用不到
(4)构造函数标签(Constructor):
规范:
/**
*
构造方法的描述
* @param name
* 按钮的上显示的文字
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
*/
(5)方法(Methods)标签:(接口和其实现类的方法,都要加注释)
注释规范:/**
*
为按钮添加颜色
*@param color
按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time 2012-11-20 15:02:29
*/
Pattern:
/**
* @Description:${todo}
* ${tags}
* ${return_type}
* @exception:
* @author: ${user}
* @time:${date} ${time}
*/
(6)覆盖方法(Overriding Methods)标签:
(7)代表方法(Delegate Methods)标签:
(8)getter方法标签:
(9)setter方法标签:
这些暂时没有定义,可以按照自己的方式添加注释。相关文章推荐
- <Java 并发编程实践>读书笔记 --- 重排序
- Java判断100内的素数
- 解决eclipse中android添加重载函数时参数为arg0,arg1的问题
- spring mvc 请求转发和重定向
- Eclipse装插件的几种方式
- spring中缓存的了解及学习
- java连接数据库方法
- 帮助文档的制作javadoc
- Java基础知识强化24:Java中异常
- SpringMVC使用poi上传Excel读取Excel实例(包含防止重复提交)
- 常见JAVA运行时异常有哪些?
- 一个不错的java学习博客
- java--jsp+ssh+select动态结合数据和选择(解)
- 深入理解java异常处理机制
- Java正则表达式基础知识及实例说明
- test4.7
- spring定时器--时间设置规则
- 远程服务器部署javaweb项目
- SpringMVC与Activiti网页流程设计器整合
- JAVA中字节流和字符流的区别 。