总结几个代码上传后报出的问题,主要是代码规范相关的,后续持续更新。
1.
Gerrit报错:
> warning:Using the ;.*;form of import should be avoided -org.junit.Assert.*
解决方法:这边是一个ExampleInstumentedTest.java文件import包的时候使用了.
的形式,把这个
改成具体的方法即可。
Gerrit报错:
warning:First sentence of javadoc is incomplete(period is missing)or not present
解决方法:
翻译一下
警告:第一句话的javadoc不完整(缺少句点)或不存在
这边我是javadoc中没有加英文句号报错。
此外,我为了方便注释采用的全是中文,这并不符合代码规范,也已改成英文了。
warning:Package name ;com.him.Repository;must match pattern;^[a-z]+(.[a-z][a-z0-9]*)*$;
解决方法:这边是包名命名错误,Repository应该是小写,repository,注意规范。
warning:Abbreviation in name;exportICMlog; must contain no more than ;1;capital letters.
警告:缩写名称;exportICMlog;必须包含不超过1个大写字母。
这边是方法名命名大小写问题,exportICMlog应该改成
exportIcmLog
Warning:4 is a magic number
这里的“魔数”就是指代码中直接出现的数字。现代编程规范比较忌讳这样写代码,一方面看不懂意思,另一方面如果这个数字多次出现,一旦需要修改的时候就需要全部找出来改掉,一旦少改一处就会产生BUG,非常麻烦。我们在编程中要尽可能避免使用“魔数”,例如写3.1416这种数字,也应该改为数学库中的π常数,例如Unity中的Mathf.PI。
版权声明:本文为ambitionLlll原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。