背景
不同开发者的代码习惯、IDE不同,社区需要统一代码格式,方便其他开发者阅读代码
以下内容从官网查找到的,不保证及时更新,对社区的贡献工作需要大家自驱,任何疑问,先多看官网给出的经验和说明
不按照格式开发的话,社区的Hadoop QA自动跑得测试是通不过的:)
1.加载hbase官方的Java code style
查看官网以下内容
http://hbase.apache.org/book.html#eclipse.code.formatting
从git上拉取hbase代码dev-support/ 目录下面找到hbase_eclipse_formatter.xml
IDE打开preferences->搜索code style
将hbase_eclipse_formatter.xml加载进来
因为IDEA和Eclipse的import 格式设置不太一样,IDEA还要做的改动:
取消星号导包
http://www.cnblogs.com/nihaorz/p/6762421.html
import部分的顺序,底下的具体设置
通过IDEA的command+ option+L格式化代码
2.jruby 的code style 验证
jruby格式验证使用的是另外一个工具:rubocop
安装:
gem install rubocop
中文说明
https://github.com/JuanitoFatas/ruby-style-guide/blob/master/README-zhCN.md
另外,可能看中文说明也不一定能找到解决方案
直接通过返回的关键字到stackoverflow上面搜索
以上只做了java和jruby的代码格式化说明,关于shell脚本等格式验证没有经过尝试,期待同学们提出新的补充说明
Tips
1、目前java 代码中switch ...case ....代码块的格式需要手动处理一下
|
2.jruby 代码command+ option+L 格式化之后,还是有一些rubocop验证通不过的
需要本地rubocop命令验证之后,根据返回信息修改的进行修改,然后再提交到jira上
总结
以上内容其实是需要大家自驱去了解的,官网不但给出了流程,还给出了很多提交的建议和例子,任何是请没有头绪的时候,主动看官网