JAVA编程规范
JAVA编程规范
规范化的编程是良好代码编写风格的开始,代码的易读性跟编码风格有很大的关系,因此规范的编码是基础,也是大型项目开发必须要的一项能力。
本篇文章一共是四个部分:
1、 JAVA的命名规范
2、 JAVA文件内的模块顺序
3、 分隔和缩进
4、 注释
一、JAVA的命名规范
1、 包
一般小写,用“.”分开,使用本公司/组织网络域名/具体的软件内部模块
包命名举例:package com.sun.java; package com.mycompany.db;
2、 类
每个单词首字母大写,一般不缩写。
接口: 一般在类名后面加上“Impl”,例如:interface ContainerImpl
抽象类: 用“Abstract”作为类命名的开头,例如:ClassAbstractBeanFactory
Test类: 一般在类名后面加上“Test”,例如:Class ContainerTest
Exception类: 一般在类名后面加上“Exception”,例如:DataNotFoundException
3、 方法
首字母小写,之后的每个单词的首字母大写,例如:run();displayInformation();
4、 变量
首字母小写,之后的每个单子首字母大写,一般习惯性的在前面加一个“m”,例如:mInflater
5、 常量
每一个单词都要大写,并且单词之间用“_”连接,例如:final static MIN_WIDTH = 4;final staticDEFAULT_CONTAINER_SIZE = 20;
二、JAVA文件内的模块顺序
一个JAVA文件中最好不要超过有2000行代码,否则程序就难以阅读。
1、JAVA文件中段落的顺序:开头注释,导入的包,类和接口声明
开头注释
导入的包:在import的时候最好不要使用“*”,不要使用import java.javax.*
类和接口声明:按public,protected,private顺序
2、 JAVA类中各部分的顺序:
a) 属性声明
b) 构造方法声明
c) Static语句
d) 普通方法声明
e) Main方法声明
f) 内部类
一般而言,一个类中的方法的代码书最好不要超过100行。
三、分隔和缩进
1、 使用空行
a) 在方法之间
b) 在注释之前
2、 使用空格
a) 运算符与运算符之间,如:c = a + b;
b) 在参数列表中的逗号后面,如: void m1(int year, int month) {}
c) 在if, for,while语句之后 如: if (a > b) {}
四、注释
1、JAVA语言的两种注释方法:
/* This is a comment */
// This is a comment
第一种会被用到JavaDoc上,都是以“/**”开头
第二种适用于部分代码的短注释
郑重声明:本站内容如果来自互联网及其他传播媒体,其版权均属原媒体及文章作者所有。转载目的在于传递更多信息及用于网络分享,并不代表本站赞同其观点和对其真实性负责,也不构成任何其他建议。