JAVA的一些编码风格学习
1. Java的文件注释头/******************************************************
* 该类功能及特点描述
*
* @see(与该类相关联的类)：(AnatherClass.java)
*
*
* 开发公司或单位：XX软件有限公司开发
* 版权：本文版权归属XX公司研发中心
*
*
* @author(作者)
*
* @since(该文件所支持的JDK版本)
*
* @version(版本)
*
* @date(开发日期)
*
* 最后更改日期：
*
* 修改人：
*
* 复审人：
******************************************************/
2. 包的声明和引用
规则一：包名应该是独一无二的
规则二：包名通常情况下都应该是小写的ASCII字母
规则三：包名一般是公司域名的倒序，经常用到得域名后缀有cn, com, edu, gov, mil, net, org
规则四：域名后面的部分可以根据习惯命命名
3. 代码行长度
一般来说Java的代码行长度应该小于80个字符。
4. 良好风格的代码：
(1) 运算
myName1 = myName2 * (myName3 + myName4 - myName5) + 4 * myName6;
(2) 方法
private static synchronized methodName(int anArg,Object anotherArg, String yetAnotherArg,Object andStillAnother){}
(3) if
if ((a == b) && (c >= d)) {}
(4) 变量声明
int a;int b;char c;String str;
(5) 变量放置
void myMethod() {int i = 0;if (condition) { int j = 0;}}
(6) ++和--
argv++;argc--;
(7) return语句
return (a + (b * c)));return (size ? 5 : 10); (8) if else语句
if (condition) {statements;}if (condition) {statements;} else {statements;}if (condition) {statements;} else if (condition) {statements;} else {statements;}
(9) switch语句
switch (condition) {case 1: statements; /*我的注释*/ break; case 2: statements; break;case 3: statements; break; default: statements; break; } (10) for
for (int i; i<10; i++) {statements;}for ( ; ; ) {statements;}
(11) while
while (condition) {statements;} (12) do-while
do {statements;} while(condition)
(13) try-catch-finally
try {statements;} catch (Exception e) {statements;} finally {statements;}
(14) 空格
空格一般应用在关键字与括号之间。
while (true) {...}一般在参数列表中的逗号后面插入空格。
myObject.myMethod(arg1, arg2, ..., argn);
数学算式的操作数与运算符之间应该添加空格(二进制运算与一元运算除外)
x = x>>3; //二进制运算a += c + d;a = (a + b) / (c * d);while (d++ == s++) {n++; //一元运算}
for语句中的表达式后面要加空格
for (int i=0; i<10; i++) {...}
(15) 空行
在下面的情形下需要插入一行空白行：
在两个方法之间；
method1() { ...}method2() { ...}
方法内部本地变量与第一个语句之间；
void f() { int i = o; while (i == 0) {... }}在块注释与单行注释之前；
在方法内部的逻辑片段之间。
(16) 常量
static final int MIN_WIDTH = 15;static final int MAX_WIDTH = 1000;
(17) 综合规则
if ((i == j) && (m == n)){ }return (condition ? x : y);try {do {...} while(isTrue);} catch(Exception ex) {...}for (int j=0; j<20; j++) {for (int i=0; i<1000; i++){...}}
页:
[1]