我们的一个团队在开发一个项目时,遇到的问题是,每个人的注释格式都是不同的,例如函数头的注释类的注释等;下面是我们项目中实施的办法,我认为很值得借鉴,所以贴过来分享一下。
=================================================================================================
1. 类的版权注释格式及设置步骤方式:
=================================================================================================
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Code -> New Java files -> Edit ->
把其中的内容修改为:
/*
* Copyright (c) 2010-2020 Founder Ltd. All Rights Reserved.
*
* This software is the confidential and proprietary information of
* Founder. You shall not disclose such Confidential Information
* and shall use it only in accordance with the terms of the agreements
* you entered into with Founder.
*
*/
${package_declaration}
${typecomment}
${type_declaration}
=================================================================================================
2.类的注释格式及设置步骤如下:
=================================================================================================
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Types -> Edit ->把注释格式设置为:
/**
* This class is used for ...
*
* @version
* 1.0, ${date} ${time}
* @author Jiang Haiying
*/
-> OK 设置完毕。
把@author改为自己的名字拼音即可. 自动生成的代码如下:
/**
* This class is used for ...
*
* @version 1.0, Apr 22, 2010 10:05:00 AM
* @author Jiang Haiying
*/
若有需要参考别的类或方法时可以加上@see标注,例如:
/**
* This class is used for ...
*
* @version 1.0, Apr 22, 2010 10:05:00 AM
* @author Jiang Haiying
* @see com.founder.mcpm.crt.dao.IBatchCompoundAnalysisDAO
*/
在生成的JavaDoc中会生成 ” 另请参见com.founder.mcpm.crt.dao.IBatchCompoundAnalysisDAO“ 的链接。
=================================================================================================
3.类的方法注释格式设置方式:
=================================================================================================
Eclipse -> Window -> Preferences -> Java -> Code Style -> Code Templates -> Comments -> Methods -> Edit ->把注释格式设置为:
/**
* ${tags}
* @author Jiang Haiying
*/
把 @author 修改为自己的品拼音名字,生成的格式如下:
/**
* @param value
* @return
* @throws Exception
* @author Jiang Haiying
*/
public String add(String value) throws Exception {
....
}
=================================================================================================
4.注意事项
=================================================================================================
<a>.对已经存在的类,若没有版权声明注释要加上版权注释。
<b>.若对已有的类修改或增强功能,在 @author 之后再添加自己的名字并用英文逗号隔开。
例如:
/**
* This class is used for ...
*
* @version 1.0, Apr 22, 2010 10:05:00 AM
* @author Jiang Haiying, Lisa
*/
<c>.当创建新的Class时,把Generate comments选中,Eclipse会自动生成类的版权注释及类的注释,否则不会生成(需要手工修改)。
=================================================================================================
5. 接口及实现类的注释样例代码
=================================================================================================
================
接口
================
/**
* Gets total count of rows by sql string.
*
* @param sql the sql string is the filter and sort condition.
* @return return 0 if there is no data.
* @throws DAOException if it occurs an error, it will throw a DAOException exception.
* @author Jiang Haiying
*/
Integer getTotalRowCount(String sql) throws DAOException;
================
实现类
================
/*
* @see com.founder.bcimp.core.dao.IBCIMPUserDAO#getTotalRowCount(java.lang.String)
*/
@Override
public Integer getTotalRowCount(String sql) throws DAOException {
return null;
}
注意:
方法异常签名时,在@throws 之后加上异常类型 DAOException
如: @throws DAOException .......
分享到:
相关推荐
这是一个通用的eclipse代码注释目标,排版非常的整齐,
MyEclipse中自动添加注释 。主要针对每次创建的类加注释,让代码更通俗易懂。
myeclipse2017ci10代码注释优化配置,直接导入即可,轻松配置
myeclipse java代码注释导入模板 Preferences->Java->Code Style->import就可以; 也可以根据自己的代码注释规范修改这个xml文件
1、Window---Preference---Java---Code Style---Code Templates 2、选择Comments---Import
对于程序员,刚开始还会写一点注释,后来熟悉了,思路长了,会很容易忘记注释,会很反感写注释,这个文档会教您如何自动配置注释,在每次写方法,写类的时候,eclipse\myeclipse会自动帮您增加注释,希望您会喜欢。
MyEclipse中设置java注释模板的方法.docx
为MyEclipse添加注释模板(定制代码注释格式)
MyEclipse设置注释格式 MyEclipse自动注释
myeclipse2017ci10代码注释优化配置,直接导入即可,轻松配置
MyEclipse配置注释风格,新建类自动生成注释
myeclipse开发注释自动生成
代码注释格式化模板,下载后解压,打开MyEclipse,在window-preferences-java-code styles-code templates里面选择import导入即可
MyEclipse Java code style 注释模板 xml 很通用的注释模板 操作方法: windows->Preferences->Java ->code style 导入xml文件即可 添加注释的快捷键是alt+shfit+J
myeclipse破解代码,已经验证6.5版本和8.5版本
MyEclipse 代码提示快捷键设置,帮助大家快速掌握MyEclipse代码提示的快捷键设置
可以选择Window->Preferences->Java->Code Style->Code Templates下的Comments,然后点击Import导入本文件,即可完成代码注释模板的导入.以后在需要注释的类或方法前使用敲入/*回车,便可以自动带入注释模板.
myeclipse简单注释模板
NULL 博文链接:https://rich8w.iteye.com/blog/701000
NULL 博文链接:https://xylonwang.iteye.com/blog/438646