java编码规范要求

开发命名规范

JAVA编码规范

目 录

1

概述 ................................................................................................................................... 3 1.1 1.2 1.3 2

编写目的 ............................................................................................................ 3 预期读者 ............................................................................................................ 3 适用范围 ............................................................................................................ 3

Document number 文档编号 Document version 文档版本 Confidentiality level 密级 Total 30 pages 共 30 页 Prepared by

拟制

Reviewed by 评审人 Approved by

批准

V1.00

Java语言编码规范

Date 日期 Date 日期

Date 日期

yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd

Java编码规范

Revision Record 修订记录

Date 日期 yyyy-mm-dd Revision Version 修订版本 Vx.xx Sec No. 修改章节 Change Description 修改描述 Author 作者 Copyright ? Worksoft Creative Software Technology NanJing Branch , Ltd. Page 2, Total 30

江苏亿科达科技发展有限公司

江苏亿科达科技发展有限公司

JAVA开发编码规范

1/18

江苏亿科达科技发展有限公司

版 本 说 明

版本 V1.0 V1.1 V1.2 制订人 夏霆 田路 夏霆 制订日期 2008-09-11 2008-10-31 2008-10-31 主要内容 JAVA开发编码规范初稿 JAVA开发编码规范修改 确认发布

2/18

江苏亿科达科技发展有限公司

一、 前言................................................................................................................... 4

1.1、 目的............................................................................................................ 4 1.2、范围.............................................................

Java语言编码规范

Java语言编码规范 (Java Code Conventions)

第 1 页 共 19 页

Java语言编码规范

目 录

一、 规范简介 .................................................................................................... 4

1 目的 .................................................................................................................................................. 4 2 范围 .......................................................................

系统开发规范

系统开发规范

编 制： 莫 小 明

版 本 历 史

1 http://www.China-soa.com 重庆斯欧信息技术有限公司

系统开发规范

目录

1

概述 ................................................................................................................................................................................... 3 1.1. 内容 ....................................................................................................................

一、单选题

1. 如下关于集合类的描述错误的是 B

A. 含有集合意义的属性命名，尽量包含其复数的意义 B. 集合中的数据不需要释放，垃圾回收器会自动回收 C. 集合必须指定模板类型

D. 使用集合类时要设置初始化容量

2. 关于线程以下说法错误的有B

A. 新起一个线程，都要使用Thread.setName(“…”)设置线程名

B. 在JDK1.5或更新的版本中，若字符串拼接发生在单线程环境，使用StringBuffer C. 对多线程访问的变量、方法，必须加锁保护，避免出现多线程并发访问引起的问题 D. 线程使用时，要在代码框架中使用线程池，避免创建不可复用的线程；禁止在循环中创建新线程，否则会引起JVM资源耗尽

3. 下面哪个是推荐使用的对称密码算法B

A. DES B. AES C. SHA D. RSA

4. 以下说法正确的有C

A. 程序中的一些状态多直接用数字表示，如函数执行成功return 1 B. 对于表示函数执行错误，多用约定的错误码来标识

C. 用有意义的静态变量或者枚举来代替数字型的程序状态，如函数执行成功return SUCCESS

D. 程序中的魔鬼数字并不可怕，需要所有开发人员努力理解这些数字的含义

5. 下列错

一、单选题

1. 如下关于集合类的描述错误的是 B

A. 含有集合意义的属性命名，尽量包含其复数的意义 B. 集合中的数据不需要释放，垃圾回收器会自动回收 C. 集合必须指定模板类型

D. 使用集合类时要设置初始化容量

2. 关于线程以下说法错误的有B

A. 新起一个线程，都要使用Thread.setName(“…”)设置线程名

B. 在JDK1.5或更新的版本中，若字符串拼接发生在单线程环境，使用StringBuffer C. 对多线程访问的变量、方法，必须加锁保护，避免出现多线程并发访问引起的问题 D. 线程使用时，要在代码框架中使用线程池，避免创建不可复用的线程；禁止在循环中创建新线程，否则会引起JVM资源耗尽

3. 下面哪个是推荐使用的对称密码算法B

A. DES B. AES C. SHA D. RSA

1

4. 以下说法正确的有C

A. 程序中的一些状态多直接用数字表示，如函数执行成功return 1 B. 对于表示函数执行错误，多用约定的错误码来标识

C. 用有意义的静态变量或者枚举来代替数字型的程序状态，如函数执行成功return SUCCESS

D. 程序中的魔鬼数字并不可怕，需要所有开发人员努力理解这些数字的含义

5.

C++语言编码规范

一、尽量严格按照要求书写代码，统一书写格式。详细格式参照《参考1_程序格式》。

二、所有头文件都应该使用#define保护来防止头文件被多重包含。

通用的方法：

#ifndef _IPROPETRY_H #define _IPROPETRY_H …… #endif

VC中可以使用的方法： #pragma once

三、使用前置声明等方法，尽量减少头文件依赖；

#pragma once class CUser;

class CTest { public: };

CTest(void); ~CTest(void); CUser* m_pUser;

四、包含的文件应按照项目源代码目录树结构排列，避免使用.（当前目录）和..（父目录）。

例如：

D:\\Work\\project\\src\\base\\logging.h 应该像返样被包含： #include \

五、包含头文件的顺序如下：

CPP的头文件 C系统文件 C++系统文件 其他库头文件 本项目内头文件

六、编写短小的函数，超过200行的函数可以考虑将它拆分；

七、不要使用magic number；把常数定义成常量或者宏来使用；

例子一：

const

C++语言编码规范

一、尽量严格按照要求书写代码，统一书写格式。详细格式参照《参考1_程序格式》。

二、所有头文件都应该使用#define保护来防止头文件被多重包含。

通用的方法：

#ifndef _IPROPETRY_H #define _IPROPETRY_H …… #endif

VC中可以使用的方法： #pragma once

三、使用前置声明等方法，尽量减少头文件依赖；

#pragma once class CUser;

class CTest { public: };

CTest(void); ~CTest(void); CUser* m_pUser;

四、包含的文件应按照项目源代码目录树结构排列，避免使用.（当前目录）和..（父目录）。

例如：

D:\\Work\\project\\src\\base\\logging.h 应该像返样被包含： #include \

五、包含头文件的顺序如下：

CPP的头文件 C系统文件 C++系统文件 其他库头文件 本项目内头文件

六、编写短小的函数，超过200行的函数可以考虑将它拆分；

七、不要使用magic number；把常数定义成常量或者宏来使用；

例子一：

const

编码规范

代码必须符合Java的编码规范。Java的编码规范包括：

?

命名规范

（1） 所有的标识符都只能用ASCII字母(A~Z或a~z)、

数字(0~9)和下划线“-”。

（2） 一个唯一包名的前缀总是全部小写的字母。例如：java.lang.util。

（3） 类名是一个名词，采用大小写混合的方式，每个单词的首字母大写。例如：Customer、

CreditAccount。

（4） 接口的大小写规则与类名相似。例如：Contactable、Prompter。

（5） 方法名是一个动词或动词词组，采用大小写混合的方式，第一个单词的首字母小写，其后

单词的首字母大写。例如：setFirstName(String firstName)、assignrole(SysUseruser)。

（6） 变量名第一个字母小写，任何中间单词的首字母大写。变量名应简短可以顾名思义，易于

记忆。例如：firstName, userAddress。避免单个字符的变量名，除非是一次性的临时变量。

（7） 常量的声明应该全部大写，每个单词之间用“-”连接。例如：MIN_BALANCE、

USER_STATUS_NORMAL。

?

注释规范

（1） 注释尽可能使用“//”