idea Java 代码编写规范

Dear 丶 2021-10-06 12:46 661阅读 0赞

1.阿里巴巴Java开发手册


2.基于上面的idea代码检查插件

  • 打开idea
  • file–>setting–>plugins–>Browse repositories…
  • 搜索alibaba可以看到Alibaba Java Coding Guidelines 点击install安装
  • 点击OK,然后重启idea
  • 右键点击工程文件或目录可以看到 “编码规约扫描”、“关闭实时检测功能”
  • 切换语言

    • Tools–>alibaba…/阿里…–>switch…/切换…

3.设置类头注释

  • 打开idea
  • file–>setting–>editor–>file and code templates–>includes–>file header
  • 输入:

    /**

    • @Author: ${USER}
    • @Date: ${DATE} ${TIME}
      */
  • 点击OK。

  • 此后,再new java class时,就会自动添加类头注释

4.设置方法头注释

  • 打开idea
  • file->setting->Editor->LiveTemplates
  • 点击右边+号,选择Template Group… 命名为user,如果已经存在则不创建。
  • 选中创建好的user,点击右边+号,选择LiveTemplate,Abbreviation命名为两个星号:**,Template text 为:

    **

    • @author $USER$
    • @Date $time$ $date$
      $param$
    • @return $retrun$
      */
  • 右边的Expand with 选择 “Enter”,点击“Edit variables”

  • 填写Expression并且按Enter键确认,其中

    USER对应 user()

    time对应 time()

    date对应 date()

    param对应 groovyScript(“def result=’’; def params=\”${_1}\”.replaceAll(‘[\\[|\\]|\\s]’, ‘’).split(‘,’).toList(); for(i = 0; i < params.size(); i++) {result+=’* @param ‘ + params[i] + ((i < params.size() - 1) ? ‘\n’ : ‘’)}; return result”, methodParameters())

    retrun对应 methodReturnType()

  • 点击OK。

  • 底部的提示“No applicable contexts yet”,点击define,勾选Java
  • 点击OK
  • 此后,写好方法名及其参数后,在方法上输入/**点击Enter键,便会添加方法头注释

发表评论

表情:
评论列表 (有 0 条评论,661人围观)

还没有评论,来说两句吧...

相关阅读

    相关 代码编写规范

    一、目的 为了更好的提高工作效率,保证开发的有效性和合理性,并可最大程度的提高程序代码的可读性和可重复利用性,便于交流和维护。 二、命名总体规范 名字应该能