Java——Java项⽬编程规范（附代码范例）JAVA项⽬编程规范
⼀、命名规范
1、 项⽬名全部⼩写
2、 包名全部⼩写
3、 类名⾸字母⼤写，如果类名由多个单词组成，每个单词的⾸字母都要⼤写。
如：public class MyFirstClass{}
4、 变量名、⽅法名⾸字母⼩写，如果名称由多个单词组成，每个单词的⾸字母都要⼤写。
如：int index=0;
public void toString(){}
5、 常量名全部⼤写
如：public static final String GAME_COLOR=”RED”;
6、所有命名规则必须遵循以下规则：
1)、名称只能由字母、数字、下划线、$符号组成
2)、不能以数字开头
3)、名称不能使⽤JAVA中的关键字。
4)、坚决不允许出现中⽂及拼⾳命名。
/**
* Java编码格式个⼈推荐，参考JDK源码和Hyperic HQ源码（原spring旗下著名开源软件，现vmware）。
* @author lihzh(苦逼coder)
* 本⽂地址：mushiqianmeng.blog.51cto/3970029/737120
*/
public class CodeRule {
//声明变量，等号两边有空格。
private static int i = 1;
//⽅法声明，右括号和左⼤括号中间有空格。
public static void main(String[] args) {
//if语句，⽐较连接符(>)左右有空格，⼩括号和⼤括号中间有空格。
//if 与左括号中间有空格
if (i > 0) {
System.out.println(i);
}
//两个条件的连接(&&)，左右有空格。
if (i > 0 && i < 2) {
System.out.println(i);
}
//if..else 语句两种格式
//1.参考JDK，个⼈使⽤⽅式，else跟⼤括号，前后都有空格
if (i > 0 && i < 2) {
System.out.println(i);
} else if (i > 2) {
System.out.println(i + 1);
} else {
System.out.println(i);
}
/
/2.参考Hyperic HQ源码, else另起⼀⾏，后仍有空格
if (i == 1) {
System.out.println(i);
}
else {
System.out.println(i);
}
//while语句，与if语句类型，while与括号中间有空格，括号内格式与if相同
while (i > 0 && i < 2) {
System.out.println(i);
i++;
}
}
//for语句，两种格式
//1.参考Hyperic HQ，个⼈使⽤⽅式。分号后带空格，每个⼦语句中，连接符左右都带空格。
//for与括号中间带空格，⼤⼩括号中间带空格。
for (int j = 0; j < 10; j++) {
System.out.println(i);
}
//2.参考JDK，区别在于⼦语句中，连接符左右⽆空格。
for (int j=0; j<10; j++) {
System.out.println(i);
}
//+-*/，格式，四则运算符号前后有空格。
//在JDK的有些代码⾥，在⽅法调⽤的参传递或在判断语句中存在的四则运算中，四则运算符号前后⽆空格。 //为了不造成困扰和混淆，个⼈为均保留空格。
int a = 1 + 2;
int b = 1 - 2;
int c = 1 * 2;
夏至下雨有什么说法int d = 1 / 2;
//三元表达式格式，每个符号中间均有空格
int j = i > 2 ? 1 : -1;
//⽅法声明和调⽤，⽤逗号分隔的参数，逗号后有空格。
sum(a, b);
sum(c + d, j);
}
//⽅法声明，多个参数，逗号后有空格
private static int sum(int i, int j) {
return i + j;
}
}
⼆、注释规范
1、 类注释
在每个类前⾯必须加上类注释，注释模板如下：祝公司发展好的贺词
/**
* Copyright (C),2006-2010,ChengDu Lovo info. Co., Ltd.
*FileName:Test.java
*类的详细说明
*
* @author 类创建者姓名
祝老人健康长寿祝福语* @Date 创建⽇期
* @version 1.00
*/
2、 属性注释
在每个属性前⾯必须加上属性注释，注释模板如下：什么是副词
/**
*提⽰信息
*/
private String strMsg = null;
3、 ⽅法注释
在每个⽅法前⾯必须加上⽅法注释，注释模板如下：
/**
*类⽅法的详细使⽤说明
*
* @param参数1参数1的使⽤说明
* @return返回结果的说明
* @throws 异常类型.错误代码注明从此类⽅法中抛出异常的说明
七夕 祝福语
对老婆说的话*/
4、 构造⽅法注释
在每个构造⽅法前⾯必须加上注释，注释模板如下：
/**
*构造⽅法的详细使⽤说明
*
* @param参数1参数1的使⽤说明
* @throws 异常类型.错误代码注明从此类⽅法中抛出异常的说明
*/
5、 ⽅法内部注释
在⽅法内部使⽤单⾏或者多⾏注释，该注释根据实际情况添加。
如：//背景颜⾊
Color bgColor = Color.RED;
基本语法
编写 Java 程序时，应注意以下⼏点：
· ⼤⼩写敏感 ： Java是⼤⼩写敏感的 ，这就意味着标识符 Hello 与 hello 是不同的。
· 类名：对于所有的类来说，类名的⾸字母应该⼤写。 如果类名由若⼲单词组成，那么每个单词的⾸字母应该⼤写，例如
MyFirstJavaClass 。
· ⽅法名：所有的⽅法名都应该以⼩写字母开头 。如果⽅法名含有若⼲单词，则后⾯的每个单词⾸字母⼤写。
· 源⽂件名：源⽂件名必须和类名相同。 当保存⽂件的时候，你应该使⽤类名作为⽂件名保存（切记 Java 是⼤⼩写敏感的），⽂件名的后缀为 .java 。（如果⽂件名和类名不相同则会导致编译错误）。
·
主⽅法⼊⼝ ：所有的 Java 程序由 public static void main(String []args) ⽅法开始执⾏。
Java 标识符
Java 所有的组成部分都需要名字。类名、变量名以及⽅法名都被称为标识符。
关于 Java 标识符，有以下⼏点需要注意：
· 所有的标识符都应该以字母（ A-Z 或者 a-z ） , 美元符（ $ ）、或者下划线（ _ ）开始
· ⾸字符之后可以是任何字符的组合
· 关键字不能⽤作标识符
· 标识符是⼤⼩写敏感的
· 合法标识符举例： age 、 $salary 、 _value 、 __1_value
· ⾮法标识符举例： 123abc 、 -salary
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论