利用Intellij Idea(Android Studio)让团队代码风格更统一

主要会用到 Intellij Idea 的下面几个功能

  1. 配置代码风格:让团队共享代码风格配置
  2. 提交时自动格式化:确保设置的格式生效
  3. annotate:快速查看某行代码最后一次被改动的时间和作者
  4. file header:统一的 Java 文件头

下面一一详细介绍:

导入代码风格配置文件:让团队共享代码风格配置

我们写代码的时候应该经常会使用“自动格式化”快捷键,而代码风格文件的作用就是定义了格式化后的代码的风格,比如什么时候应该换行/空行,什么时候必须有括号等。以 Google 提供的 Code Style配置文件为例。配置路径如图:

导入路径:设置-Editor-CodeStyle-Java-Scheme-ImportScheme-Intellij IDEA code style XML

如果对现有的代码风格不满意,可以做上面的界面中作出调整,然后导出新的配置文件,分享给团队其他成员。导出方法,点击上图中的 “Export” 即可(蓝色高亮的Import Scheme上方)。

提交时自动格式化:确保设置的格式生效

如果没有这个功能,那么仍然会有一些不符合定义风格的代码被提交到Git/SVN中,这个功能则是做提交代码的时候自动进行一次格式化(前提是需要使用IDEA自带的Git/SVN功能提交代码)

开启方法如图:
图2

同时也建议开启Optimize imports,会自动去掉无用的 import 语句。

annotate:快速查看某行代码最后一次被改动的时间和作者

有时我们会想知道某行代码最后是被谁修改的/在什么时间修改的,第一反应可能是去看Git提交历史,但IDEA提供里更简单快速的方法:Annotate。开启方法很简单:右键点击平时打断点的区域,选择“Annotate”, 前后对比效果见下图,开启后显示出了类中每一行代码最后被修改的日期和修改人。

图3

注意:Annotate功能比较消耗性能,建议中有需要时才开启。

file header:统一的 Java 文件头

这里的文件头值的是 java 文件上方的描述(见图4红框内),规范的文件头会让之后的维护更加容易,比如想要找出某个同事在某段时间写的代码,很容易就可以搜索出来。


图4

设置方法如图5:


图5

@author 这一行需要自行修改为你想要的名字/邮箱
TODO desc 会添加一行TODO,提醒添加类的功能描述。

设置好之后,新创建的每一个类,都会自动加上这样一段注释,就不需要我们每次手动编写署名/日期了。

关于让团队代码风格更统一的功能,就暂时介绍到这里了,之后还会有其他文章介绍怎样更高效地利用Intellij IDEA,感谢阅读。

推荐阅读更多精彩内容

  • 到单位两月了,反思自己做了什么,又学到了什么。刚开始,坚持每天看书,无论是专业书还是闲书。虽然环境是轻松的,...
    叶子sunshine阅读 32评论 0 1
  • 晚上九点,211路的末班车如约而来,一样黑黑的车厢,暗红的荧光屏。 在去年的这个时候,我写到我多么渴望一场措不及防...
    请叫我小二先生阅读 115评论 1 3
  • 月從斷山口,遥吐柴門端。 萬木分空霽,流陰中夜攢。 光連虚象白,氣與風露寒。 谷靜秋泉響,巖深青靄殘。 清澄入幽夢...
    Gooooooooo阅读 18评论 0 0
  • 【】回嵊州(79) 【】王红娟 佳信六月传, 喜讯抵万金, 初闻喜涟涟, 欣喜狂乘车, 一路狂奔飞台州, 两山鸣啼...
    白雪公主123阅读 139评论 0 10
  • 针对敏感的关键词做替换,每个关键词至少写一个,(邀请好友、转发朋友圈、微信群、免费、扫码、关注、分享) 邀请好友:...
    吕星如阅读 24评论 0 0