文档介绍：JAVA源代码规范
JAVA代码规范
- 1 -
JAVA代码规范
(初稿)
JAVA代码规范
- 2 -

JAVA代码规范
- 3 -
版本更新信息
本版本创建/修改、维护、批准涉及人员如下：
创建/修改者：XX
维护者：XX
批准者：XX
具体版本更新记录如表1-1：
表1-1 版本更新记录
版本号
修改确认日期
修改人
修改位置
修改方式
（AMD）
修改内容概述

XX
全部
A
初始版本发布
修改方式：A－增加 M－修改 D－删除
JAVA代码规范
- 4 -
目的
本文提供一整套编写高效可靠的 Java 代码的标准、约定和指南。它们以安全可靠的软件工程原则为基础，使代码易于理解、维护和增强灵活性。通过遵循一套通用的程序设计标准，显著提高 Java 软件开发者的生产效率，为开发团队的程序设计带来更大的一致性，使软件开发团队的效率明显提高。
规范的执行
本文档适用于公司内进行软件开发的所有技术人员，即公司内软件开发人员编写的所有源代码都必须遵循本规范。
除临时性项目之外的任何项目均应严格按照此标准执行，“临时性项目”指：
为市场推广目的而编写的示程序
为一次性用途而编写的临时性小程序
为学****目的而编写的测试程序
文档类别
本文档属标准规范类的项目限制级文档，未经总经理及总经理授权人员批准，不得提供公司以外的人员阅读和使用。
版本更新条件
本文档的定期评审时间为每年的1月，评审及修订步骤依据SEPG工作规范规定。此外，如遇下列条件可进行评审，并根据评审结果决定是否需要进行修订：
本文档所列的引用的标准已经更新。
本文档的使用者若对本文档有任何评论、建议或意见，请通过企业内部网络发电子邮件给SEPG，所收到的电子邮件将会在评审和修订时给予充分的考虑。
使用对象
本文档的使用对象包括：
项目管理者
质量保证人员
软件开发人员
JAVA代码规范
- 6 -
目录
1 介绍 7
为什么要有编码规范 7
2 通用代码格式 7
文件组织 7
缩进 8
行长度 8
换行 8
空行 10
空格 10
注释 11
注释约定 11
实现注释的格式 12
文档注释 13
快速浏览 javadoc 13
声明 14
每行声明变量的数量 14
初始化 14
布局 15
类和接口的声明 15