关于代码规范的学习

编码规范

1 前言
为确保系统源程序可读性,从而增强系统可维护性,java编程人员应具有基本类似的编程风格,兹制定下述Java编程规范,以规范系统Java部分编程。系统继承的其它资源中的源程序也应按此规范作相应修改。

2 适用范围
本文档将作为java编程人员软件开发的编程格式规范。在项目Java部分的编码、测试及维护过程中,要求严格遵守。

3 命名规范
定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。

3.1 Package 的命名
Package 的名字应该都是由一个小写单词组成。示例:unipost.trans

3.2 Class 的命名
Class 的名字每个单词必须由大写字母开头而其他字母都小写的单词组成。示例:FileMng

3.3 Class 成员的命名
变量、方法、属性:大小写混排的单词组成,首字母小写

示例: functionName、countNum、size

3.4 Static Final 变量的命名
Static Final常量:大写单词组成,单词之间使用“_”连接

示例: MAX_INDEX

3.5 前后台变量名称
前台变量 fg_变量名

后台变量 bg_变量名

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

3.7 数组的命名
数组应该总是用下面的方式来命名:

1 byte[] buffer;
2 而不是:
3 byte buffer[];

3.8 方法的参数
使用有意义的参数命名,如果可能的话,使用和要赋值的属性一样的名字:

1 setCounter(int size)
2 {
3     this.size = size;
4 }
原文地址:https://www.cnblogs.com/9635741zly/p/14916451.html