华为JAVA编码规范.pdf
本资源摘要信息中,我们将详细介绍华为JAVA编码规范的主要内容,包括编码风格、命名约定、代码组织、注释要求等方面的内容。
编码风格
1. 程序块采用缩进风格,空格为 4 个。
2. 分界符(如大括号 { 和})应各自占一行并且在同一列,同时与引用它们的语句左对齐。
3. 较长(>80 字符)的语句、表达式和参数要分多行,长表达式要在低优先级操作符划分新行,操作符放在行首,新行要适当缩进,整齐,语句可读。
命名约定
1. 变量、方法和类的命名应该遵循驼峰命名法(Camel Case)。
2. 类名和接口名使用大驼峰命名法(Pascal Case)。
3. 变量名和方法名使用小驼峰命名法(Camel Case)。
代码组织
1. 类和接口的定义应放在同一个文件中。
2. 相对独立的程序块、变量、说明要加空行。
3. 一行只写一条语句。
注释要求
1. 包的注释写入一个名为 package.html 的 HTML 格式的说明文件,放入当前路径。
2. 文件注释写入文件头部,包名之前。
3. 类和接口注释放在 package 注释之后,class 或 interface 之前。
4. 成员变量注释内容:成员变量的意义、目的、功能、可能被用到的地方。
5. 公有和保护方法注释的内容:方法的一句话功能描述、功能详细描述、输入参数、输出参数、返回值、违例说明。
异常处理
1. 对于方法内部用 throw 抛出的异常,要在方法的注释中标明。
2. 对于调用其他方法抛出的异常,选主要的在注释中说明。
3. 对于非 RuntimeException,即 throws 子句声明会抛出的异常,必须在方法的注释中标明。
华为JAVA编码规范提供了详细的编码风格、命名约定、代码组织和注释要求,以确保编写的代码清晰、可读、易维护。同时,规范也对异常处理进行了规定,确保代码的可靠性和稳定性。