Java是一门面向对象编程语言。

Java开发注释规范

1.通用规范

1.1  类、类属性、类方法的注释必须使用 Javadoc 规范,使用:

/**内容*/格式,不得使用 // xxx 方式。

说明:在 IDE 编辑窗口中,Javadoc 方式会 示相关注释,生成 Javadoc 可以正确输出相应注 释;在 IDE 中,工程调用方法时,不进入方法即可悬浮示方法、参数、返回值的意义, 高阅读效率。

1.2  所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、异常说明外,还必须指出该方法做什么事情,实现什么功能。

说明:对子类的实现要求,或者调用注意事项,请一并说明。

1.3  所有的类都必须添加创建者和创建日期。

1.4  方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释使用/* */注释,注意与代码对齐。

1.5  所有的枚举类型字段必须要有注释,说明每个数据项的用途。

1.6  与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持 英文原文即可。

反例:“TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。

1.7  代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑 等的修改。

说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后, 就失去了导航的意义。

1.8  谨慎注释掉代码。在上方详细说明,而不是简单的注释掉。如果无用,则删除。

说明:代码被注释掉有两种可能性:

1)       后续会恢复此段代码逻辑。

2)       永久不用。

前者如果没 有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。

1.9  特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫 ,经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1)    待办事宜(TODO):( 标记人,标记时间,[预计处理时间]) 表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的Javadoc还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。

2)    错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])。在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。

2.class注释

@brief 概要描述

@details详细描述

@date  类创建时间

@author    类创建作者(git对应账户名)

3.方法的具体注释

请使用快捷键”/**”,打完后,自动生成的注释就可以了,比如:

/**
 * 
 * @param 
context
 
@return
 
*/

l   在最上面的空格部分,请写明方法的主要业务逻辑、关键算法及注意事项,另外如果使用了设计模式,也要说明。

l   注意:在每个自动生成的需要写注释的项目,都要写注释代码,对于代码编写过后不存在的参数请及时删除 。

4.sql mapper 注释

@brief 概要描述

@details详细描述

@date  类创建时间

@author    创建作者

通过在mapper文件中添加<!-- -->添加在sql注释中。

例子:

<!-- 

    a)  @brief 概要描述

    b)  @details详细描述

    c)  @date  类创建时间

    d)  @author    创建作者

 -->

<selectid="selectByMap"parameterType="map"   resultMap="BaseResultMap">

      select name,id from user_user;

</select>

业务处理模块内只能单表查询,报表可以允许三表join。 

不允许where条件为空,或者where 1=1的语句。

单次查询不允许返回超过500条数据。如果是数据导出可以分页导出。另外推荐分页时,使用id作为下次查询的条件,否则后续分页会越来越慢。 

5.git提交注释

请说明本次提交代码是修改、新增信息,主要修改内容。

注释规范:#[new/opt/bug]@版本#env/空:配置说明

# 为注释

new/opt为新增或者修改或bug修复

@后面为版本

#后面为环境相关,如果需要运维配置的需要加env,无关的不需要填

:后面为配置说明

例如:new@release5.1.0#env:中行支付密钥

符号必须是应该 不要使用中文的:#

6.Mapper.xml中自增主键的获取

自增主键的获取用 useGeneratedKeys="true" keyProperty="id" 获取,例如:

<insert id="insertSelective" useGeneratedKeys="true" keyProperty="id" parameterType="com.youzhu.user.dao.entity.Renter">


当前位置:Java教程网 »
本文地址:http://www.javajcw.com/84.html
喜欢 or
默认图片
发表我的评论
取消评论