华为JAVA编程规范(6)
时间:2025-04-20
时间:2025-04-20
规则7 注释应与其描述的代码相近,对代码的注释应放在其上方,并与其上面的代码用空行隔
开,注释与所描述内容进行同样的缩排。(1.42+)
说明:可使程序排版整齐,并方便注释的阅读与理解。 示例: /*
* 注释 */
public void example2( ) {
// 注释
CodeBlock One
// 注释
CodeBlock Two }
/*
* 注释 */
public void example( ) {
// 注释
CodeBlock One
// 注释
CodeBlock Two }
规则8 对于switch语句下的case语句,必须在每个case分支结束前加上break语句。(1.42+) 说明:break才能真正表示该switch执行结束,不然可能会进入该case以后的分支。至于语法上合法的场景“一个case后进入下一个case处理”,应该在编码设计上就避免。
规则9 修改代码同时修改相应的注释,以保证注释与代码的一致性。不再有用的注释要删除。
(1.42+)
规则10 注释的内容要清楚、明了,含义准确,防止注释二义性。(1.42+) 说明:错误的注释不但无益反而有害。
规则11 避免在注释中使用缩写,特别是不常用缩写。(1.42+) 说明:在使用缩写时或之前,应对缩写进行必要的说明。
规则12 对重载父类的方法必须进行@Override声明(5.0+)
Page 6 , Total 19
上一篇:中医药人才培养措施