zoukankan      html  css  js  c++  java
  • 注释规范和code review

    1.idea统一注释格式

    类注释、方法注释必须包含署名、时间、入参、出参说明等。方法体内代码行注释及字段注释需按照JavaDoc标准编写,必要的步骤需进行注释说明。未实现或有疑问的,使用 // TODO 进行注释说明。

    模板设置:

    方法注释:
    **
    * 方法名: $NAME$
    * 方法描述: TODO <br>
    * $PARAMS$
    * @return {@link $RETURN$}
    * @date 创建时间: $DATE$ $TIME$ <br>
    * @author {个人名字}
    */

    类注释:
    /**
    * 类名称:$NAME$<br>
    * 类描述:TODO <br>
    * @date 创建时间:$DATE$ $TIME$<br>
    *
    * @author {个人名字}
    * @version 1.0.0
    */

    示例:

    字段注释:

    代码注释:

    2.静态代码检查

    静态代码检查:开发者本地需安装SonarLint,阿里规约p3c,同时idea工具的代码规范扫描,开启严格模式,严格要求代码长度篇幅,代码框架,代码规范,命名规范等各方面检查。

    服务端代码检查,采用SonarQube和GitLab双重Review,idea的SonarLint可配置连接我们的SonarQube服务进行检查规则同步。SonarQube地址: (可使用GItLab账号一键登录,登录后,找组长分配权限)

    GitLab的代码Review,采用分支合并请求的方式,由组长进行代码Review。

    同时,项目代码将不定时抽查,组会Review代码,将在代码中进行// FIX 建议,修改后方可提测、上线。

  • 相关阅读:
    Hive(二)CentOS7.5安装Hive2.3.3
    Hive(一)Hive初识
    CentOS7.5搭建ELK6.2.4集群及插件安装
    开发工具之Spark程序开发详解
    Java多线程编程
    数据迁移之Sqoop
    CentOS7.5之Sqoop1.4.7的安装使用
    Hadoop案例(十一)MapReduce的API使用
    Hadoop案例(十)WordCount
    BSScrollViewEdgePop
  • 原文地址:https://www.cnblogs.com/andy0816/p/15733443.html
Copyright © 2011-2022 走看看