软件开发代码规范(Java)

软件开发代码规范 （C）

(仅通普信息技术股份有限公司供内部使用)

拟制： 杨超 审核： 夏峰 核准： 冯敬刚 签发： 韩殿成 文档版本：V1.11

日期： 2015-3-10 日期： 2015-3-10 日期： 2015-3-17 日期： 2015-3-21

黑龙江通普信息技术股份有限公司

版本历史

日期 版本 说明 作者 目录

第一章 代码开发规范及其指南 ............................................................................................................. 1 1.1 目的 ............................................................................................................................................... 1 1.2 程序内命名规范............................................................................................................................ 1 1.3 文件命名规范 ............................................................................................................................... 2 1.4 JAVA 文件样式 ............................................................................................................................... 2 1.5 代码编写格式 ............................................................................................................................... 6 第二章 程序编写规范方法 ..................................................................................................................... 8 2.1 权限修饰 ....................................................................................................................................... 8 2.2 其他规范 ....................................................................................................................................... 8 2.3 编程指南 ..................................................................................................................................... 10 第三章 其他要求 ................................................................................................................................... 12

第一章 代码开发规范及其指南

1.1 目的

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的，增加可读性，减少项目组中因为换人而带来的损失。（这些规范并不是一定要绝对遵守，但是一定要让程序有良好的可读性）

1.2 程序内命名规范

? Package 的命名 ：Package 的名字应该都是由一个小写单词组成。 ? Class 的命名 ：Class 的名字必须由大写字母开头而其他字母都小写的单词

组成

? Class 变量的命名 ：变量的名字必须用一个小写字母开头。后面的单词用大

写字母开头。

? Static Final 变量的命名 ：Static Final 变量的名字应该都大写，并且指出完

整含义。

? 参数的命名 ：参数的名字必须和变量的命名规范一致。

? 数组的命名 ：数组应该总是用下面的方式来命名： byte[] buffer; 而不是

byte buffer[];

? 方法的参数 ：使用有意义的参数命名，如果可能的话，使用和要赋值的字

段一样的名字：

SetCounter(int size){ this.size = size; }