当前位置：文档之家 › j2ee代码书写基础规范

j2ee代码书写基础规范

  • 格式：doc
  • 大小：155.00 KB
  • 文档页数：10

密级：公开代码书写基础规范制定日期：2010年1月中航国际金网公司版本历史目录1前言 ..............................................................................................................................................................- 3 -1.1版权声明 .................................................................................................... - 3 -1.2规范等级说明 ............................................................................................. - 3 -1.3规范实施建议 ............................................................................................. - 3 -2代码风格规范.............................................................................................................................................- 3 -2.1空行 ........................................................................................................... - 3 -2.2代码行........................................................................................................ - 3 -2.3缩进对齐 .................................................................................................... - 4 -3命名规范 .....................................................................................................................................................- 4 -3.1项目的命名................................................................................................. - 4 -3.2包的命名 .................................................................................................... - 4 -3.3类的命名 .................................................................................................... - 4 -3.4接口的命名................................................................................................. - 5 -3.5方法的命名................................................................................................. - 5 -3.6变量的命名................................................................................................. - 5 -3.7常量的命名................................................................................................. - 5 -3.8jsp文件的命名............................................................................................ - 5 -3.9css文件的命名 ........................................................................................... - 5 -3.10其他文件的命名 ...................................................................................... - 6 -4注释规范 .....................................................................................................................................................- 6 -4.1通用注释规则 ............................................................................................. - 6 -4.2类的注释 .................................................................................................... - 6 -4.3方法的注释................................................................................................. - 6 -4.4失效代码的注释.......................................................................................... - 7 -4.5变量、常量的注释 ...................................................................................... - 7 -4.6分支语句的注释.......................................................................................... - 7 -4.7特殊代码的注释.......................................................................................... - 8 -5编程规范 .....................................................................................................................................................- 8 -5.1变量 ........................................................................................................... - 8 -5.2常量 ........................................................................................................... - 8 -5.3类............................................................................................................... - 8 -5.4方法 ........................................................................................................... - 8 -5.5语句 ........................................................................................................... - 9 -5.6其他规范 .................................................................................................... - 9 -1前言本文档反映的是中航国际金网公司开发团队的编码规范。

1.1版权声明本规范由中航国际金网公司技术专家委员会制定、维护。

1.2规范等级说明根据实际情况，分为2类等级规范：●必要：默认级别，要求所有项目中的所有成员遵守。

对于新建或优化改造系统，开发维护人员必须严格遵守和保持。

对于历史系统和小范围调整的系统（2010年前上线的系统），开发维护人员可以根据实际情况进行实施。

●推荐规范（该条目标记为【推荐】）：推荐规范即非强制规范，只是推荐和鼓励开发维护人员实施的编码规范，各个项目根据实际情况执行。

1.3规范实施建议该规范是以提高软件开发质量和效率为目标，辅以IDE等开发工具为保障，逐步改进编码规范化水平。

对于格式规范、注释规范等部分规范的要求，可以通过使用eclipse自带的Format方法（快捷键：Ctrl+Shift+F）进行自动格式化，可以提高开发效率又符合编码规范。

合集下载

代码编写规范5篇

代码编写规范5篇

代码编写规范5篇第一篇：代码编写规范代码编写规范1、所有代码排版整齐，可以使用编程工具自带的排版功能；2、代码缩进使用Tab键，不允许使用空格；3、标示符的声明：修饰符与变量名之间留一空格；4、用途相近的变量声明之间不加空行；用途相差很远的变量声明之间加一空行进行区分；5、变量声明要集中，不允许分散在程序代码之间；6、对于语意不明确的变量名要增加注释进行说明；7、对于方法功能要进行注释说明；对于功能非常简单的，并且可以直接从方法名称推断出其具体功能的方法，可以不加注释；所有的方法注释必须准确；8、方法的排列顺序要依照功能的排列顺序进行排列；9、CSS样式代码编写顺序需要按照页面的排版顺序进行排列，不同的组件样式之间要以明显的“分隔符”进行分隔；10、Html代码排版一定要规范，按照不同标签的层次关系进行适当的缩进排列，缩进使用Tab键，不允许使用空格；11、Java代码的编写，首先进行变量声明，接下来是构造方法，在接下来是一些其他的功能方法，最后是变量的get/set方法。

如果有嵌入类或嵌入接口的声明，应该放在文件最后，且需要增加注释详细说明；12、JS代码的编写，首先是一些全局变量的声明，接下来是一些功能方法，最后是初始化代码。

不同的方法之间要保留适当的空行，不允许使用alert。

第二篇：域代码编写总结word域代码详解域的基本操作Ctrl+F9 插入域Ctrl+Shift+F9把域转为纯文本 Shift+F9 切换为域代码显示十个特殊指令(域开关)1、数组a2、括号b3、平移d4、分式f5、积分i6、列表l7、重叠o8、根号r9、上下标s10、框x域代码： {EQ a(100，2，31)}讲解： {EQ列表(100，2，31排成一列)}可用参数：al左对齐；ac居中；ar右对齐；con元素排成 n 列；vsn行间增加 n 磅；hsn列间增加n磅al左对齐域代码： {EQ aal(100，2，31)}讲解： {EQ 列表左对齐(100，2，31)}ac居中域代码：{EQ aac(100，2，31)}讲解：{EQ 列表居中对齐(100，2，31)}ar右对齐域代码：{EQ aar(100，2，31)}讲解：{EQ 列表右对齐(100，2，31)}con元素排成n列域代码：{EQ aco3(10，2，31，0，1，0，14，3，55)}讲解：{EQ 列表元素排成3列(10，2，31，0，1，0，14，3，55)}vsn 行间增加n磅域代码：{EQ aco3vs2(10，2，31，0，1，0，14，3，55)}讲解：{EQ 列表元素排成3列行间增加2磅}hsn 列间增加n磅域代码：{EQ aco3vs2hs4(10，2，31，0，1，0，14，3，55)} 讲解：{EQ 列表元素排成3列行间增加2磅列间增加4磅}域代码：{EQ b(a(100，2，31))}讲解：{EQ 加括号(数组(100，2，31))}可用参数：左括号使用字符 lc；右括号使用字符 rc；左右括号都使用字符bc lc* 左括号使用字符*域代码：{EQ blc|(a(100，2，31))}讲解：{EQ 加括号左括号使用字符|(数组(100，2，31))}rc* 右括号使用字符*域代码：{EQ brc|(a(100，2，31))}讲解：{EQ 加括号右括号使用字符|(数组(100，2，31))}bc* 左右括号都使用字符*域代码：{EQ bbc|(a(100，2，31))}讲解：{EQ 加括号左右括号使用字符|(数组(100，2，31))}注意：如果指定的字符*是 {、[、(、或 <，Word 将使用相应的字符作为右括号。

java 编程规范

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编程规范的一部分，具体的规范还需要根据具体的项目和团队来制定。

遵循编程规范可以提高代码质量和可维护性，提升团队的协作效率。

代码书写规范

代码书写规范

代码书写规范代码书写规范是指在编写代码时应遵守的一系列规定，目的是为了提高代码的质量、可读性和可维护性。

下面是一些常见的代码书写规范：1. 命名规范：- 使用有意义且描述准确的变量名、函数名和类名，避免使用缩写和单个字母作为标识符。

- 使用驼峰命名法或下划线命名法来命名变量、函数和类。

例如：myVariable、get_data()、User_Account。

- 避免使用保留字作为标识符。

- 类名应该以大写字母开头，而变量和函数名应以小写字母开头。

2. 缩进与空格：- 使用空格或制表符进行代码的缩进，并在整个项目中保持一致。

- 通常使用4个空格作为一个缩进级别。

- 避免使用制表符和空格混用，以免造成代码混乱和显示问题。

3. 代码注释：- 在关键地方添加详细的代码注释，解释代码的作用、实现思路和注意事项。

- 不要过多地注释显而易见的代码。

- 注释应该易于理解和阅读，避免使用过于复杂或晦涩的语言。

4. 函数与方法：- 函数和方法应该具有明确的功能，遵循单一职责原则。

- 避免使用过长的函数或方法，可以通过拆分成多个小函数来提高可读性和可维护性。

- 对于公共方法，应当提供文档注释，描述其功能、参数和返回值。

5. 代码格式：- 采用一致的代码风格，包括缩进、空格、括号位置等。

- 使用合适的空行和空格来组织代码，提高可读性。

- 对于长的代码行，可以适当地换行，使用反斜杠或括号来连接。

- 使用代码块包裹逻辑片段，例如使用花括号{}包裹if语句和循环语句。

6. 异常处理：- 在可能发生异常的代码块添加异常处理逻辑，保证程序的稳定性和可靠性。

- 避免使用空的try-catch块，应该在catch块中添加具体的异常处理信息。

7. 导入语句：- 明确导入的模块，避免导入整个模块。

- 每个导入语句只导入一个模块，避免使用通配符导入。

8. 版本控制：- 使用版本控制工具，如Git，对代码进行管理。

- 提交代码前应进行代码格式化和静态代码检查。

java代码规范

java代码规范

java代码规范Java代码规范是一套约定俗成的编程规范，旨在提高代码的可读性、可维护性和可重用性。

以下是一些常见的Java代码规范：命名规范：1. 类名使用大驼峰命名法，例如MyClass。

2. 方法名和变量名使用小驼峰命名法，例如myMethod。

3. 常量名使用全大写字母和下划线，例如MAX_VALUE。

4. 包名使用全小写字母，例如com.example.mypackage。

代码格式规范：1. 使用四个空格缩进，避免使用制表符。

2. 每行代码不超过80个字符，超出则换行。

3. 使用空格将运算符、逗号和分号与操作数分开，例如"int a =b + c;"。

4. 在左括号前后加一个空格，例如"if (condition) {"。

5. 在方法的左花括号前加空格，例如"public void myMethod() {"。

6. 使用大括号括起的代码块独占一行。

7. 在逻辑上相关的代码块之间使用空行分隔。

注释规范：1. 在类、方法和成员变量定义之前使用Javadoc注释说明其作用、参数和返回值。

2. 在方法内部使用注释解释代码的逻辑。

3. 避免使用不必要的注释，代码应尽可能自解释。

代码质量规范：1. 遵循SOLID原则，尽量将代码设计为松耦合、高内聚的模块。

2. 避免使用魔术数字，使用常量代替。

3. 使用异常处理机制来处理可预料的异常情况，不要捕获所有异常。

4. 避免使用全局变量，尽量将变量的作用范围限制在最小范围内。

5. 避免代码冗余和重复，尽量使用工具类和设计模式来重用代码。

测试规范：1. 使用单元测试框架（例如JUnit）编写测试用例，并确保每个方法都有相应的测试用例。

2. 使用断言来验证预期结果和实际结果是否一致。

3. 测试方法的命名应描述被测试方法的功能和预期结果。

版本管理规范：1. 使用版本管理工具（例如Git）来管理代码的版本和变更历史。