需要介绍类的详细说明(包括author) 示例
/**
* 消息提醒处理
* @author hcl
*/
@Service
public class MessageApiService {}
需要介绍方法的功能、参数说明、返回值说明 示例
/**
* 执行提醒查询
* @param request 查询请求
* @return 提醒信息
*/
public MessageResponse query(MessageRequest request) {}
需要说明属性的含义 示例
/**
* 名称
*/
private String name;
注:使用/** */注释,不要使用//注释
可用英文或者拼音,要见名知意,首字母大写,驼峰命名法 示例
/**
* 展示信息
* @author gengdh
*
*/
public class QueryEntityMember {}
可用英文或者拼音,要见名知意,首字母小写,驼峰命名法 示例
/**
* 查询消息提醒内容
* @param request
* @return 提醒信息集
*/
private Map<String,Object> queryMessages(MessageRequest request)
可用英文或者拼音,要见名知意,首字母小写,驼峰命名法。若属性在数据库中没有相对应的字段,不要使用数据库字段命名方法命名属性,以免混淆。 示例
/**
* 类型
*/
private String type;
常量命名全部大写,单词间用下划线隔开,要见名知意 示例
/**
* nested类型
*/
public final static String TYPE_NESTED="nested";
3.1关闭流 流的关闭,必须在finally里面用IOUtils类的方法关闭 示例
FileOutputStream out=null;
try {
out=new FileOutputStream(new File(outputDir+"content.json"));
json.writerWithDefaultPrettyPrinter().writeValue(out, contents);
}catch(Exception e) {
throw new RuntimeException(e);
}finally{
IOUtils.closeQuietly(out);
}
出现异常情况需要使用error(String msg, Throwable t)方法打印日志。 示例
try {
List<MessageZf> zfs = msgs.getZfs();
if(this.msgs == null||StringUtils.isBlank(this.msgs.getType())||zfs==null) {
return;
}
for (MessageZf messageZf : zfs) {
this.process(messageZf,this.msgs.getType());
}
} catch (Exception e) {
logger.error("消息提醒添加异常",e);
}
对于插入,更新,查询的sql格式需要简洁明了,#{}中需要写出jdbcType属性 示例
insert into DB_JY..T_INDEX_EVENT (
ID,
MAIN_ID,
SRC_ID,
SRC,
ACTION,
TASK_ID,
CREATE_TIME,
STATE,
VALID,
PARENT_ID
)
values (
#{id,jdbcType=CHAR},
#{mainId,jdbcType=VARCHAR},
#{srcId,jdbcType=VARCHAR},
#{src,jdbcType=VARCHAR},
#{action,jdbcType=VARCHAR},
#{taskId,jdbcType=VARCHAR},
#{createTime,jdbcType=TIMESTAMP},
#{state,jdbcType=INTEGER},
#{valid,jdbcType=VARCHAR},
#{parentId,jdbcType=VARCHAR}
)
对于含有大于和小于号的情况用<![CDATA[sql语句]]>形式书写 示例
<![CDATA[
DELETE DB_JY..T_INDEX_EVENT
WHERE
CREATE_TIME < #{createTime,jdbcType=TIMESTAMP}
AND STATE <=0
]]>