Neusoft Co., Ltd.
命名规范
• 常量命名 – 建议都为大写字母 – 用下划线分隔单词 如：MIN_VALUE, MAX_BUFFER_SIZE, PTION_FIEL_NAME
Neusoft Co., Ltd.
命名规范
• 方法命名 – 采用大小写混合的形式 – 以小写字母开头，其他单词（或只取首字母的缩写单词） 以大写字母开头，所有其它字母小写。 – 不使用下划线分隔单词 – 方法命名应能描绘出方法的作用和功能 – 建议使用祈使动词或动词短语 – 获取或设置类属性的方法建议显示的命名为getProperty() 或setProperty()，其中property是类的属性的名字 – 用于判断类的布尔属性的方法建议显示的命名为 isProperty()，property是指类的属性的名字※
Neusoft Co., Ltd.
命名规范
• 变量命名 – 采用大小写混合的形式 – 以小写字母开头，名字中其他单词（或只取首字母的缩写 单词）以大写字母开头，其它都为小写字母 – 不使用下划线分隔 – 应为名词或名词短语 例： boolean resizable; char recordDelimiter
Neusoft Co., Ltd.
空白的使用
• 缩进 – 要求是四个空格 TAB在不同的源代码管理工具中因为用户设置的不同宽度 不相同，因此不要使用TAB – 建议修改各管理工具的设置将TAB字符扩展为4个空格 • 行的延续（折行） – 行应为120列，超出此限制应截成比较短的行 – 在逗号之后折行或一个操作符之前折行△ – ※尽可能采用高层次的折行 – ※折行后对齐上一行语句同一层的起始位置 – ※如果上面规则不适用，则缩进4个字符
空பைடு நூலகம்的使用
• 空行 有益于将代码按照逻辑分段，以提高代码的可读性。※ 下列情况用一个空行： – 在版权声明、包声明块、引用声明块之后 – 在类的声明之间 – 在方法的声明之间 – 在类中声明最后一个属性之后，声明第一个方法之前
Neusoft Co., Ltd.
空白的使用
• 空格 下列情况建议使用单个空格： – 在一个关键字和它所修饰的块之间。如：catch, for, if, switch, synchronized, while。注意super, this后不要跟空 格 – 任何关键字和它所用的参数之间。如：return true; – 一个列表中逗号之后。如： foo(long_exp1, long_exp2, long_exp3); // GOOD foo(long_exp1,long_exp2,long_exp3); // BAD 下列情况不建议使用空格： – 左括号和后一个字符之间 – 右括号和前一个字符之间 if (i == 42) // GOOD if( i == 42 ) // BAD
Neusoft Co., Ltd.
Beyond Technology
编码规范及代码检查
软件开发事业部 程文治 2018/11/17
Neusoft Co., Ltd.
编码规范
Neusoft Co., Ltd.
内容
• • • • • • • • • • 目的 源程序 命名规范 空白的使用 注释 类 接口 语句 性能优化常识 其它
Neusoft Co., Ltd.
命名规范
• 类和接口的命名 – 一般由大写字母开头其它字母小写的单词组成 – 专有的缩写词除外，如：AWTException – class名字建议用名词或名词短语 – interface名字取决于其主要功能和用途 • 是使Object具有特定的功能，建议使用可以描述此功 能的形容词（加上-able或者-ible后缀）如： Searchable, Sortable, NetworkAccessible等 • 否则，建议使用名词或者名词短语
Neusoft Co., Ltd.
源程序
• 源文件的组织 – 版本信息和版权声明 • 作为源文件开始。 • *建议使用开发工具（如Eclipse）的注释功能自动完成此 类工作。
– *使用部门统一的格式化和模版文件(只能在Eclipse
中使用)。
Neusoft Co., Ltd.
源程序
• 源文件的组织 – 版本信息和版权声明 • 包的声明必须是非注释的第一行，用一个空格分隔 package关键字与包的名字，如： – package com.neusoft.softdev.firewall; • 引用声明 – 从第一列开始 – 用一个空格分配import关键字和引用类型名。 – 应保证引入类都被使用，减少引入*的使用。 ※ »import java.sql.SQLException; //GOOD »Import java.sql.*; // BAD • 类或接口声明 – 每个源程序必须有一个class或interface声明
Neusoft Co., Ltd.
命名规范
• 标签命名 主要针对break和continue等语句的。※ – 应为小写字母 – 使用下划线分隔单词 – 不要在同一个方法中多次使用同一个标签名
Neusoft Co., Ltd.
空白的使用
• • • • 空行 空格 缩进 行的延续（折行）
Neusoft Co., Ltd.
Neusoft Co., Ltd.
代码规范的目的
• • • • • 代码的编写保持一致性 提高代码的可读性和可维护性 方便团队中的成员之间共享代码 易于代码的回顾 ……※
Neusoft Co., Ltd.
源程序
• 源程序命名 – 名字：源程序中定义的class或interface的名字 – 后缀： .java • 供发布的文件 – 名字：应该是有代表性的 – 后缀： *.jar(推荐使用)；或*.zip、*.ear、*.war等 • 源文件的组织 – 应按如下顺序书写，并且各元素之间至少一个空行分隔： • 1）版本信息和版权声明 • 2）包的声明 • 3）引用声明 • 4）类或接口的声明
Neusoft Co., Ltd.
命名规范
• • • • • • 包的命名 类和接口的命名 变量命名 常量命名 方法命名 标签命名
Neusoft Co., Ltd.
命名规范
• 包的命名 – 全部由小写字母组成。 – 如： package telmecall.business.console; package telmecall.business.exception; package telmecall.presentation.util;