华为Java语言编码规范标准
华为JAVA编程规范

1 Java 编程规范1.1 排版1.1.1 规则规则1程序块要采用缩进风格编写,缩进的空格数为4个,不允许使用TAB缩进。
(1.42+)说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。
规则2分界符(如大括号‘{’和‘}’)应各独占一行,同时与引用它们的语句左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。
(1.42+) 示例:if (a>b){doStart();}规则3较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
(1.42+)示例:if (logger.isDebugEnabled()){logger.debug("Session destroyed,call-id"+ event.getSession().getCallId());}规则4不允许把多个短语句写在一行中,即一行只写一条语句(1.42+)说明:阅读代码更加清晰示例:如下例子不符合规范。
Object o = new Object(); Object b = null;规则5if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。
(1.42+)说明:阅读代码更加清晰,减少错误产生示例:if (a>b){doStart();}case x:{int i = 9;}规则6相对独立的程序块之间、变量说明之后必须加空行。
(1.42+)说明:阅读代码更加清晰示例:if(a > b){doStart();}//此处是空行return;规则7在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。
java编码规范(建议稿,修改自华为规范)(1)解析

武汉中软卓越科技有限公司Java语言编码规范Table of Contents 目录1. 范围 (3)2. 术语和定义 (3)3. 排版规范 (4)3.1. 规则 (4)3.2. 建议 (6)4. 注释规范 (7)4.1. 规则 (7)4.2. 建议 (12)5. 命名规范 (14)5.1. 规则 (14)5.2. 建议 (15)6. 编码规范 (17)6.1. 规则 (17)6.2. 建议 (20)7. JTEST规范 (22)7.1. 规则 (22)7.2. 建议 (23)1.范围本规范规定了使用Java语言编程时排版、注释、命名、编码和JTest的规则和建议。
本规范适用于使用Java语言编程的案例、产品和项目。
2.术语和定义规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。
格式:对此规范格式的说明。
说明:对此规范或建议进行必要的解释。
示例:对此规范或建议从正、反两个方面给出例子。
3.排版规范3.1.规则3.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。
说明:对于由开发工具自动生成的代码可以有不一致。
3.1.2.*语句块分隔符左括号‘{’应与语句块引用代码在同一行,右括号‘}’应另起一行并与语句块引用代码左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:如下例子不符合规范。
for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}应如下书写:for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}3.1.3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
java 编码规则

java 编码规则
Java编码规则是指在编写Java程序时需要遵循的一系列规范和约定,旨在提高代码的可读性、可维护性和可扩展性。
下面是一些常见的Java编码规则:
1. 代码缩进:使用四个空格进行缩进,不要使用制表符。
2. 代码行长度:每行代码尽量不超过80个字符,超过时可以换行。
3. 命名规范:使用驼峰命名法,即首字母小写,后面每个单词的首字母大写。
4. 类名:类名使用名词或名词短语,首字母大写。
5. 方法名:方法名使用动词或动词短语,首字母小写。
6. 变量名:变量名使用名词或名词短语,首字母小写。
7. 常量名:常量名应全部大写,并用下划线分隔单词。
8. 注释:为代码添加适当的注释,解释代码的用途、实现细节等。
9. 空格使用:在运算符两侧、逗号后面、冒号后面等地方使用空格,增加代码的可读性。
10.代码格式化:使用合适的缩进、空行、大括号等格式化代码,以增强可读性。
遵循这些Java编码规则可以使你的代码更易于理解和维护。
此外,还可以使用一些静态代码分析工具来自动检查代码是否符合编码规范,如Checkstyle、FindBugs等。
编码规则的遵守不仅仅是个人习惯的问题,也是一个团队合作的重要环节,通过统一的编码规范可以提高代码的一致性,方便开发人员的协作和项目的维护。
java 编程规范

java 编程规范Java编程规范是为了促进Java代码的可读性、可维护性和可扩展性而制定的标准。
以下是一些常见的Java编程规范:一、命名规范1. 类名、接口名、枚举名首字母大写,采用驼峰命名法。
2. 变量名、方法名首字母小写,采用驼峰命名法。
3. 常量名全部大写,使用下划线分割单词。
4. 包名全部小写,使用点号分割单词。
二、代码格式1. 使用4个空格缩进。
2. 每行代码长度不超过80个字符。
3. 在二元运算符(如赋值、算术运算、逻辑运算)两侧添加空格。
4. 在逗号、冒号、分号之后添加空格。
5. 在左花括号之后和右花括号之前添加空格。
6. 在注释之前添加空格。
三、代码结构1. 类的成员按照作用域排列,先是静态成员,然后是实例成员。
2. 类的方法按照功能排列,先是构造方法,然后是其他方法。
3. 每个类只负责一个功能,遵循单一职责原则。
4. 使用适当的访问修饰符控制成员变量和方法的访问级别。
四、异常处理1. 不要捕获异常而不做任何处理,应该记录日志或者抛出更高级别的异常。
2. 不要将整个方法体放在try-catch块中,应该只捕获需要处理的异常。
3. 不要使用异常控制程序的流程,应该使用条件语句或者循环结构。
五、注释规范1. 使用Javadoc注释对类、方法、参数、返回值进行说明。
2. 在每个类的头部使用Javadoc注释描述该类的功能。
3. 使用内联注释对代码进行解释、补充和说明。
4. 注释应该清楚、简明、不冗余,遵循自然语言的习惯。
六、其他规范1. 避免使用魔法数值,应该使用常量或者枚举来表示。
2. 使用块注释对重要的代码块进行标注,方便阅读和查找。
3. 使用业界公认的缩写和术语,避免拼写错误和歧义。
4. 使用合适的数据结构和算法来解决问题,避免低效的代码。
以上仅是Java编程规范的一部分,具体的规范还需要根据具体的项目和团队来制定。
遵循编程规范可以提高代码质量和可维护性,提升团队的协作效率。
java 规范

java 规范Java的编码规范是一种旨在提高代码质量和可维护性的指南。
以下是Java编码规范的一些重要原则和规定。
1. 命名规范:- 类名应使用大写字母开头的驼峰命名规范,如:ClassName。
- 方法名、变量名应使用小写字母开头的驼峰命名规范,如:methodName。
- 常量名应使用全部大写的蛇形命名规范,如:CONSTANT_NAME。
2. 缩进和空格:- 使用四个空格进行缩进,不要使用Tab键。
- 二元操作符前后应添加空格,如:a + b。
- 不要在括号内添加空格,如:(a + b)。
3. 大括号和代码块:- 大括号应与相关的代码放在同一行,如:```if (condition) {// code here} else {// code here}```- 单行的代码块也应使用大括号包裹起来。
4. 注释:- 使用Javadoc格式的注释来描述类、方法等的用途。
- 在代码中添加必要的注释,解释代码的逻辑和实现细节。
5. 异常处理:- 建议使用try-catch语句来处理可能抛出异常的代码块。
- 不要捕获所有异常,只捕获你能够处理的异常。
6. 包的命名:- 包的命名应全部使用小写字母,多个单词之间用点号分隔,如:com.example.packageName。
7. 类的设计:- 类的设计应符合单一职责原则,即每个类只有一个主要职责。
- 类应该是可扩展和可重用的,应遵循开闭原则。
8. 方法的设计:- 方法应该尽量简洁,只做一件事情。
- 方法的命名应能清楚地描述它的功能和返回值类型。
9. 代码的可读性:- 避免使用过长的代码行,一行不应超过80个字符。
- 使用空行来分隔逻辑上不同的代码块。
- 使用合适的缩进和空格来增加代码的可读性。
这些只是Java编码规范的一部分内容,旨在提高代码的可读性、可维护性和一致性。
遵循这些规范可以帮助团队成员更好地理解和修改代码,减少潜在的错误和问题。
Java语言编程规范华为

精心整理DKBA华为技术有限公司企业技术规范DKBA1040-2001.12代替(DKBA200106-003)目次前言 (3)1范围11 2规范性引用文件11 3术语和定义11 4排版规范121252.包的注释:包的注释写入一个名为package.html的HTML格式的说明文件放入当前路径。
163.包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
164.文件注释:文件注释写入文件头部,包名之前的位置。
165.文件注释内容:版权说明、描述信息、生成日期、修改历史。
176.类和接口的注释:该注释放在package关键字之后,class或者interface关键字之前。
18187.类和接口的注释内容:类的注释主要是一句话功能简述、功能详细描述,8.类属性、公有和保护方法注释:写在类属性、公有和保护方法上面。
19199.成员变量注释内容:成员变量的意义、目的、功能,可能被用到的地方。
1910.公有和保护方法注释内容:列出方法的一句话功能简述、功能详细描述、输入参数、输出参数、返回值、违例等。
2011.对于方法内部用throw语句抛出的异常,必须在方法的注释中标明,对于所调用的其他方法所抛出的异常,选择主要的在注释中说明。
对于非RuntimeException,即throws子句声明会抛出Array7.注释尽量使用中文注释和中文标点。
方法和类描述的第一句话尽量使23用简洁明了的话概括一下功能,然后加以句号。
接下来的部分可以详细描述。
238.顺序实现流程的说明使用1、2、3、4在每个实现步骤部分的代码前面进行注释。
9.一些复杂的代码需要说明。
23 6命名规范246.1规则24241.包名采用域后缀倒置的加上自定义的包名,采用小写字母。
在部门内部应该规划好包名的范围,防止产生冲突。
部门内部产品使用部门的名称加上模块名称。
产品线的产品使用产品的名称加上模块的名称。
242.类名和接口使用类意义完整的英文描述,每个英文单词的首字母使用大写、其余字母使用小写的大小写混合法。
java 编码规范

java 编码规范《Java编码规范》1. 代码风格- 代码缩进:使用4个空格进行缩进,不使用制表符。
- 行长限制:每行代码不超过80个字符,超出则进行换行。
- 行尾空格:行尾不留空格。
- 行尾注释:行尾注释与代码之间至少保留2个空格的距离。
- 命名规范:使用驼峰命名法,类名首字母大写,变量和方法名首字母小写。
- 常量命名:常量使用全大写字母,并用下划线分隔单词。
- 空行:类与方法之间保留一个空行,方法内逻辑块之间保留一个空行。
2. 注释规范- 文件注释:每个源文件的头部必须包含文件注释,说明该文件的作者、日期等信息。
- 类注释:每个类的头部必须包含类注释,描述该类的作用、用法等。
- 方法注释:每个方法必须包含方法注释,描述该方法的功能、参数、返回值等。
- 代码注释:在代码中需要加入注释说明的地方,添加合理的注释来增加代码可读性。
3. 包和导入规范- 包名规范:包名全部小写,多个包名之间用英文句点"."分隔,采用反域名形式命名。
- 导入规范:不要使用通配符"*"导入整个包,应明确导入所需的类。
4. 类和接口规范- 类结构顺序:依次按照成员变量、构造方法、普通方法的顺序来编写类的结构。
- 成员变量声明:先声明公有的静态常量,再声明私有的静态变量,接着声明私有的实例变量。
- 构造方法:在类的开头部分声明构造方法,按照方法名和参数顺序进行编写。
- 方法和变量:局部变量应放在使用的最近位置上,避免声明太早或太迟,增加代码的可读性。
5. 异常处理规范- 异常的捕获和处理:在可能发生异常的地方进行捕获和处理,而不是简单地将异常抛出给上层调用者。
- 不要捕获并忽略异常:捕获异常后应该进行适当的处理,而不是简单地将异常信息打印出来或者忽略它们。
6. 标准化代码结构- 采用分层结构:将代码按照功能、模块进行划分,每个模块或类负责一部分功能。
- 逻辑清晰:保持代码逻辑清晰,避免重复、冗余的代码,使用合适的设计模式来优化代码结构。
华为Android平台Java编程规范

Android平台Java编程规范(文档编号/ IPD-CMMI V1.3 / 仅供内部使用)Huawei Technologies Co., Ltd.华为技术有限公司All rights reserved版权所有侵权必究DKBA华为技术有限公司企业技术规范DKBA1040-2008.12 Android平台Java编程规范2008-12-24发布2008-12-25实施Revision record 修订记录目录前言 (7)1范围 (8)2规范性引用文件 (8)3术语和定义 (8)4排版规范 (8)4.1.规则 (8)4.1.1*缩进风格 (8)4.1.2分界符‘{’和‘}’ (9)4.1.3*较长的语句、表达式或参数 (10)4.1.4*不允许把多个短语句写在一行中 (10)4.1.5*if, for, do, while, case, switch, default 等语句自占一行, (10)4.1.6*相对独立的程序块之间、变量说明之后必须加空行。
(11)4.1.7*对齐只使用空格键,不使用TAB键。
(11)4.1.8*关键字、变量、常量进行对等操作 (11)4.2建议 (12)4.2.1交叉放置 (12)5注释规范 (13)5.1规则 (13)5.1.1注释量 (13)5.1.2包的注释 (13)5.1.3包注释内容 (13)5.1.4文件注释 (14)5.1.5类和接口注释 (14)5.1.6类和接口的注释内容 (15)5.1.7类属性、公有和保护方法注释 (16)5.1.8成员变量注释内容 (16)5.1.9异常抛出 (18)5.1.10*注释与代码放置 (18)5.1.11*注释与描述内容的缩排 (19)5.1.12* 将注释与其上面的代码用空行隔开 (19)5.1.13* 对变量的定义和分支语句(条件分支、循环语句等)必须编写注释 (20)5.1.14* switch语句下的case语句 (20)5.1.15* 注释的管理 (20)5.1.16*注释的内容 (20)5.1.17* 注释中的缩写 (20)5.1.18注释语言 (21)5.1.19删除代码的注释 (21)删除代码,特别是删除多行代码、删除方法、成员变量等需要有明确注释,便于版本升级;删除android原始代码必须要求有明确注释。
编码规范(华为)

软件编程规范总则
1 排版
¹1-4:循环、判断等语句中若有较长的表达式或语句,则要进行适应的划分,长表达式要在低 优先级操作符处划分新行,操作符放在新行之首。 示例: if ((taskno < max_act_task_number) && (n7stat_stat_item_valid (stat_item))) { ... // program code }
act_task_table[taskno].duration_true_or_false = SYS_get_sccp_statistic_state( stat_item );
report_or_not_flag = ((taskno < MAX_ACT_TASK_NUMBER)
仅供内部使用
2
Simpo PDF Merge and Split Unregistered Version -
录
6 11 18 20 22 28 36 40 44 50 52 53
Simpo PDF Merge and Split Unregistered Version -
软件编程规范总则
1 排版
1 排版
¹1-1:程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。 ¹1-2:相对独立的程序块之间、变量说明之后必须加空行。 示例:如下例子不符合规范。 if (!valid_ni(ni)) { ... // program code } repssn_ind = ssn_data[index].repssn_index; repssn_ni = ssn_data[index].ni;
if (...) { ... // program code }
Java语言编程规范--华为01年

DKBA华为技术有限公司企业技术规范DKBA1040-2001.12代替(DKBA200106-003)Java语言编程规范2001-12-XX发布2001-12-XX实施华为技术有限公司发布目次前言 (3)1 范围112 规范性引用文件113 术语和定义114 排版规范124.1 规则121.*程序块要采用缩进风格编写,缩进的空格数为4个。
12122.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
133.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
4.*不允许把多个短语句写在一行中,即一行只写一条语句13135.*if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}。
6.*相对独立的程序块之间、变量说明之后必须加空行。
137.*对齐只使用空格键,不使用TAB键。
14148.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。
4.2 建议15151.类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。
5 注释规范165.1 规则161.一般情况下,源程序有效注释量必须在30%以上。
16162.包的注释:包的注释写入一个名为 package.html的HTML格式的说明文件放入当前路径。
163.包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
Java语言编码规范

Java语言编码规范目录1.范围 (3)2.规范性引用文件 (3)3.术语和定义 (3)4.排版规范 (4)4.1.规则 (4)4.2.建议 (6)5.注释规范 (7)5.1.规则 (7)5.2.建议 (12)6.命名规范 (15)6.1.规则 (15)6.2.建议 (16)7.编码规范 (18)7.1.规则 (18)7.2.建议 (21)8.规范 (23)8.1.规则 (23)8.2.建议 (24)1.范围本规范规定了使用Java语言编程时排版、注释、命名、编码的规则和建议。
本规范适用于使用Java语言编程的产品和项目。
2.规范性引用文件下列文件中的条款通过本规范的引用而成为本规范的条款。
凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。
凡是不注日期的引用文件,其最新版本适用于本规范。
3.术语和定义规则:编程时强制必须遵守的原则。
建议:编程时必须加以考虑的原则。
格式:对此规范格式的说明。
说明:对此规范或建议进行必要的解释。
示例:对此规范或建议从正、反两个方面给出例子。
4.排版规范4.1.规则4.1.1.*程序块要采用缩进风格编写,缩进的空格数为4个。
说明:对于由开发工具自动生成的代码可以有不一致。
4.1.2.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
示例:如下例子不符合规范。
for (...) {... // program code}if (...){... // program code}void example_fun( void ){... // program code}应如下书写:for (...){... // program code}if (...){... // program code}void example_fun( void ){... // program code}4.1.3.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
java编码规则

Java编码规则是指在编写Java代码时应该遵循的一些规范和约定。
这些规则可以帮助开发者提高代码的可读性、可维护性和可扩展性。
以下是一些常见的Java编码规则:
1. 命名规范:类名使用大写字母开头的驼峰式命名法,方法名和变量名使用小写字母开头的驼峰式命名法。
2. 缩进规范:每个缩进级别使用4个空格,而不是制表符,这样可以避免在不同的编辑器中出现不同的缩进距离。
3. 注释规范:每个类和方法都应该有文档注释,说明它们的作用、参数、返回值和异常等信息。
同时,对于复杂的代码块也应该添加注释。
4. 包命名规范:包名应该全部使用小写字母,并且应该基于域名反转命名。
例如,com.example.app。
5. 文件命名规范:类文件应该与类名相同,并使用驼峰式命名法。
例如,MyClass.java。
6. 代码风格规范:代码应该按照一定的风格排列,例如在每个方法之间应该有空行,在每个语句结束时应该使用分号,在括号周围不应该有空格等。
7. 异常处理规范:对于可能抛出异常的代码块,应该使用try-catch语句或者声明抛出异常。
同时,应该在捕获异常时至少打印异常信息。
8. 安全性规范:应该避免使用不安全的函数,例如eval()和exec()
等,应该使用安全的函数或者自己实现安全策略。
9. 性能规范:应该尽可能地优化代码,例如避免使用不必要的对象、减少方法调用次数等。
以上是一些常见的Java编码规则,当然还有很多其他的规则可以根据需要进行补充和完善。
java编码规范

java编码规范Java编码规范是为了提高代码的可读性、可维护性和可重用性而制定的规范。
本文将向您介绍一些常见的Java编码规范,以帮助您编写高质量的Java代码。
1. 命名规范- 类名使用大写开头的驼峰命名法,例如`MyClass`。
- 方法名使用小写开头的驼峰命名法,例如`myMethod`。
- 变量名使用小写的驼峰命名法,例如`myVariable`。
- 常量名使用全大写并用下划线分隔单词,例如`MAX_SIZE`。
- 包名使用全小写并用点分隔单词,例如`com.example.myapp`。
2. 注释规范- 类、方法和变量前应添加注释,说明其作用和用法。
- 可以使用`//`进行行注释,例如:`// This is a comment`。
- 可以使用`/* */`进行块注释,例如:```/** This is a block comment* It can span multiple lines*/```- 每个文件应包含版权信息和作者信息的注释。
3. 缩进规范- 使用4个空格进行缩进,不使用制表符。
- 每个代码块应该有一个缩进级别。
4. 括号规范- 左括号应该在语句或声明的同一行,并在后面加上一个空格。
- 右括号应该独占一行。
```if (condition) {// code here}```5. 空格规范- 在二元运算符之间、逗号之后和分号之后应添加一个空格。
- 在关键字和左括号之间、左括号和参数之间、方法名和左括号之间不应有空格。
6. 异常处理规范- 在可能引发异常的代码周围使用`try-catch`块来处理异常。
- 在`catch`块中处理异常,不要简单地打印异常信息。
- 在方法声明中使用`throws`关键字指定可能抛出的异常。
7. 包规范- 包名应该反映代码的层次结构和功能。
- 不要使用Java的保留关键字作为包名。
8. 导入规范- 不要使用通配符导入,应该明确导入需要使用的类。
Java语言编程规范--华为01年

、DKBA华为技术有限公司企业技术规范代替(DKBA200106-003)^Java语言编程规范^2001-12-XX发布2001-12-XX实施华为技术有限公司发布目次前言 (3)1 范围112 规范性引用文件113 术语和定义114 排版规范12规则121.*程序块要采用缩进风格编写,缩进的空格数为4个。
12122.*分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。
在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。
133.*较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。
4.*不允许把多个短语句写在一行中,即一行只写一条语句13135.*if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}。
6.*相对独立的程序块之间、变量说明之后必须加空行。
137.*对齐只使用空格键,不使用TAB键。
14148.*在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。
建议15151.类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。
5 注释规范16规则161.一般情况下,源程序有效注释量必须在30%以上。
16162.包的注释:包的注释写入一个名为的HTML格式的说明文件放入当前路径。
163.包的注释内容:简述本包的作用、详细描述本包的内容、产品模块名称和版本、公司版权。
4.文件注释:文件注释写入文件头部,包名之前的位置。
165.文件注释内容:版权说明、描述信息、生成日期、修改历史。
java语言规范

java语言规范Java语言规范是指用于指导Java程序设计的一系列准则和规范。
遵循Java语言规范可以帮助程序员编写出清晰、可读性强、稳定、可维护和易于理解的Java代码。
以下是Java语言规范的一些重要准则和规范:1. 标识符:Java中的标识符是用于命名变量、类、方法等的。
标识符必须以字母、下划线或者美元符号开头,后面可以使用字母、数字、下划线或者美元符号。
标识符不能是Java的保留字。
2. 区分大小写:Java是区分大小写的语言,变量名、方法名等的大小写是敏感的。
3. 缩进和空格:为了提高代码可读性,应该在代码块开始和结束处适当缩进,并且在关键字、运算符等之间使用空格,不要把多个语句写在同一行。
4. 注释:Java有三种注释方式:块注释,行注释和文档注释。
块注释用/* ... */包围,行注释用//开头,文档注释是指以/** ... */包围的注释,一般用于生成API文档。
5. 常量:Java中的常量是指在程序执行期间不能被改变的值。
常量一般使用关键字final声明,并采用全大写字母的命名方式。
6. 类和接口命名:类和接口的命名一般采用大驼峰命名法,即每个单词首字母大写,例如MyClass,而不是myClass或者MYClass。
7. 变量和方法命名:变量和方法的命名一般采用小驼峰命名法,即第一个单词的首字母小写,后面的单词首字母大写,例如myVariable,myMethod。
8. 方法长度和复杂性:为了提高代码的可读性和可维护性,一个方法的长度应该适度,并且控制方法的复杂性。
推荐一个方法的长度不超过一屏,并且只做一件事情。
9. 异常处理:Java提供了异常机制来处理程序运行时产生的异常。
程序员应该适当捕捉和处理异常,并给用户提供友好的提示信息。
10. 类设计:一个类应该有清晰的职责和功能,并且遵循高内聚、低耦合的设计原则。
一个类的命名应该反映它的功能,并且应该保持单一职责原则。
以上只是Java语言规范的一部分,还有很多准则和规范可以帮助程序员编写高质量的Java代码。
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
Document number 文档编号 Confidentiality level 密级 内部公开 Document version 文档版本 Total 30 pages 共 30 页 V1.00
Java语言编码规范
Prepared by 拟制 Date 日期 yyyy-mm-dd
Reviewed by 评审人 Date 日期 yyyy-mm-dd
Approved by 批准 Date 日期 yyyy-mm-dd .
. . Revision Record 修订记录 Date 日期 Revision Version 修订版本 Sec No. 修改章节 Change Description 修改描述 Author 作者
yyyy-mm-dd Vx.xx .
. . Table of Contents 目录 1. 范围 ......................................................................... 4 2. 规范性引用文件 ............................................................... 4 3. 术语和定义 ................................................................... 4 4. 排版规范 ..................................................................... 5 4.1. 规则 ......................................................................... 5 4.2. 建议 ......................................................................... 7 5. 注释规范 ..................................................................... 9 5.1. 规则 ......................................................................... 9 5.2. 建议 ........................................................................ 15 6. 命名规范 .................................................................... 17 6.1. 规则 ........................................................................ 17 6.2. 建议 ........................................................................ 18 7. 编码规范 .................................................................... 20 7.1. 规则 ........................................................................ 20 7.2. 建议 ........................................................................ 24 8. JTEST规范 ................................................................... 26 8.1. 规则 ........................................................................ 26 8.2. 建议 ........................................................................ 27
.
. . 1. 范围 本规范规定了使用Java语言编程时排版、注释、命名、编码和JTEST的规则和建议。 本规范适用于使用Java语言编程的产品和项目。
2. 规范性引用文件 下列文件中的条款通过本规范的引用而成为本规范的条款。凡是注日期的引用文件,其随后所有的修改单(不包括勘误的内容)或修订版均不适用于本规范,然而,鼓励根据本规范达成协议的各方研究是否可使用这些文件的最新版本。凡是不注日期的引用文件,其最新版本适用于本规范。
序号 编号 名称 1 公司- DKBA1040-2001.12 《Java语言编程规范》
3. 术语和定义 规则:编程时强制必须遵守的原则。 建议:编程时必须加以考虑的原则。 格式:对此规范格式的说明。 说明:对此规范或建议进行必要的解释。 示例:对此规范或建议从正、反两个方面给出例子。 .
. . 4. 排版规范 4.1. 规则 4.1.1. *程序块要采用缩进风格编写,缩进的空格数为4个。 说明:对于由开发工具自动生成的代码可以有不一致。
4.1.2. *分界符(如大括号‘{’和‘}’)应各独占一行并且位于同一列,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序都要采用如上的缩进方式。 示例:如下例子不符合规范。 for (...) { ... // program code }
if (...) { ... // program code }
void example_fun( void ) { ... // program code } 应如下书写:
for (...) { ... // program code }
if (...) { ... // program code }
void example_fun( void ) { ... // program code }
4.1.3. *较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,语句可读。 示例: if (filename != null && new File(logPath + filename).length() < LogConfig.getFileSize()) { ... // program code } . . . public static LogIterator read(String logType, Date startTime, Date endTime, int logLevel, String userName, int bufferNum)
4.1.4. *不允许把多个短语句写在一行中,即一行只写一条语句 示例:如下例子不符合规范。 LogFilename now = null; LogFilename that = null;
应如下书写: LogFilename now = null; LogFilename that = null;
4.1.5. *if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while等语句的执行语句无论多少都要加括号{}。 示例:如下例子不符合规范。 if(writeToFile) writeFileThread.interrupt();
应如下书写: if(writeToFile) { writeFileThread.interrupt(); }
4.1.6. *相对独立的程序块之间、变量说明之后必须加空行。 示例:如下例子不符合规范。 if(log.getLevel() < LogConfig.getRecordLevel()) { return; } LogWriter writer;
应如下书写: if(log.getLevel() < LogConfig.getRecordLevel()) { return; }
LogWriter writer; int index;
4.1.7. *对齐只使用空格键,不使用TAB键。 说明:以免用不同的编辑器阅读程序时,因TAB键所设置的空格数目不同而造成程序布局不整齐。JBuilder、UltraEdit等编辑环境,支持行首TAB替换成空格,应将该选项打开。 . . . 4.1.8. *在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者前后要加空格;进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加空格。 说明:采用这种松散方式编写代码的目的是使代码更加清晰。 由于留空格所产生的清晰性是相对的,所以,在已经非常清晰的语句中没有必要再留空格,如果语句已足够清晰则括号内侧(即左括号后面和右括号前面)不需要加空格,多重括号间不必加空格,因为在Java语言中括号已经是最清晰的标志了。 在长语句中,如果需要加的空格非常多,那么应该保持整体清晰,而在局部不加空格。给操作符留空格时不要连续留两个以上空格。 示例: (1) 逗号、分号只在后面加空格。 int a, b, c;
(2) 比较操作符, 赋值操作符"="、 "+=",算术操作符"+"、"%",逻辑操作符"&&"、"&",位域操作符"<<"、"^"等双目操作符的前后加空格。 if (current_time >= MAX_TIME_VALUE) a = b + c; a *= 2; a = b ^ 2;
(3) "!"、"~"、"++"、"--"、"&"(地址运算符)等单目操作符前后不加空格。 flag = !isEmpty; // 非操作"!"与内容之间 i++; // "++","--"与内容之间
(4) "."前后不加空格。 p.id = pid; // "."前后不加空格
(5) if、for、while、switch等与后面的括号间应加空格,使if等关键字更为突出、明显。 if (a >= b && c > d)
4.2. 建议 类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。 格式: 类定义 { 类的公有属性定义