idea Java 代码编写规范

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 条评论
登录 后参与评论

相关文章

来自专栏拭心的安卓进阶之路

Android 进阶13:几种进程通信方式的对比总结

不花时间打基础,你将会花更多时间解决那些不必要的问题。 RPC 是什么 RPC 即 Remote Procedure Call (远程过程调用) 是一种计算机通...

2805
来自专栏JetpropelledSnake

RESTful源码学习笔记之RPC和Restful深入理解

RPC 即远程过程调用(Remote Procedure Call Protocol,简称RPC),像调用本地服务(方法)一样调用服务器的服务(方法)。通常的实...

923
来自专栏淡定的博客

php之laravel学习常见错误2(连载中)

下面是我们整理的php的laravel学习的常见的错误以及解决的办法,我还会持续更新,请关注

702
来自专栏技术/开源

开源API测试工具 Hitchhiker v0.6更新 - 改进压力测试

Hitchhiker 是一款开源的支持多人协作的 Restful Api 测试工具,支持Schedule, 数据对比,压力测试,支持上传脚本定制请求,可以轻松部...

2251
来自专栏晓晨的专栏

使用 JMeter 进行压力测试

2922
来自专栏木木玲

Netty in action ——— Bootstrapping

1072
来自专栏Jackson0714

PHP内核之旅-1.生命周期

1142
来自专栏SpringBoot 核心技术

SpringCloud组件:Eureka服务注册中心内置的REST节点列表

你有没有考虑过Eureka Client与Eureka Server是通过什么方式进行通讯的? 为什么Client启动成功后Server就会被注册到Serve...

5512
来自专栏惨绿少年

AWStats日志分析系统

AWStats是一款功能强大且功能强大的免费工具,可以图形方式生成高级Web,流媒体,ftp或邮件服务器统计信息。此日志分析器用作CGI或命令行, 并在几个图形...

1351
来自专栏FreeBuf

使用fuzzDB进行web安全测试

写在前面: fuzzDB看字面意思就知道,他是一个用于fuzz网站的库。类似于wwwscan之类工具的字典,但是他的过人之处是他是“开源”的,会有很多大神帮你维...

3248

扫码关注云+社区