文档介绍：介绍
为什么需要编码规范?
编码规范对于程序员而言尤为重要,有以下几个原因:
一个软件的生命周期中,80%的花费在于维护, 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护,编码规范可以改善软件的可读性,可以让新程序员尽快而彻底地理解新的代码,保持工程的可延续性.
时间久了后,对自己写的代码也陌生了许多,理解上容易出错.
代码无法让其他同事接手或接手的人容易改错,版本一周一个,那自己也失去了所有的休假时间(婚假?陪产假?正常周末?正常年假?等等).
更多编码知识以及陷阱参考.
来自书籍:<编写可读代码> <efficient java> <重构-改善既有代码的实现> <改善Java程序的151个建议> <代码整洁之道> <深入java虚拟机>等
感想:读的书越多懂的越多写的代码越多而后思考,越感觉自身的不足跟知识缺陷,保持谦虚的心学****是进步的动力。学点技术做个demo容易,做出能有千万上亿用户的产品,比中彩票概率还低,还得保持高速迭代不出问题(用户量大了,任何妄图侥幸心理的想法都会破灭,bug一定会出现),难上加难. 唯一的出路就是高质量的代码.
Java 排版规范
排版
规则
程序块要采用缩进风格编写,缩进的空格数为4个,我们都统一使用eclipse所以可以使用tab作为缩进快捷键。
说明:缩进使程序更易阅读,使用空格缩进可以适应不同操作系统与不同开发工具。
分界符(如大括号‘{’和‘}’)应各独占一行,同时与引用它们的语句左对齐。在函数体的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序或者static、,synchronized等语句块中都要采用如上的缩进方式。
示例:
if (a>b){
doStart();
}
较长的语句、表达式或参数(>80字符)要分成多行书写,长表达式要在低优先级操作符处划分新行,操作符放在新行之首(sql语句字符串拼接为了可读性除外),划分出的新行要进行适当的缩进,使排版整齐,语句可读。
示例:
if (()){
("Session destroyed,call-id"
+ ().getCallId());
}
/**
* 网银导入添加网银来源账户
* ***@param cardType
* ***@param bankName
* ***@param cardNum
* ***@param pleteCardNum
* ***@param repayDay
* ***@param billDay
* ***@param creditLimit
* ***@param cashCreditLimit
* ***@param currencyType
* ***@param ountId
* ***@param sourceType
* ***@param importHistoryId
* ***@param houseHolder
* ***@return account id
*/
public long ountForEbank(
int cardType,
String bankName,
String cardNum,
String pleteCardNum,
int repayDay,
int billDay,
BigDecimal creditLimit,
BigDecimal cashCreditLimit,
String currencyType,
long ountId,
int sourceType,
long importHistoryId,
String houseHolder) {
}
不允许把多个短语句写在一行中,即一行只写一条语句
说明:阅读代码更加清晰
示例:如下例子不符合规范。
Object o = new Object(); Object b = null;
if, for, do, while, case, switch, default 等语句自占一行,且if, for, do, while,switch等语句的执行语句无论多少都要加括号{},case 的执行语句中如果定义变量必须加括号{}。
说明:阅读代码更加清晰,减少错误产生
示例:
if (a>b){
doStart();
}
case x:{
int i = 9;
}
相对独立的程序块之间、变量说明之后必须加空行。
说明:阅读代码更加清晰
示例:
if(a > b)