一.排版
1.代碼縮進(jìn)
代碼塊要采用縮進(jìn)的風(fēng)格進(jìn)行編寫,縮進(jìn)的個(gè)數(shù)為4個(gè)。
2.長(zhǎng)句分割
較長(zhǎng)的語句良拼、表達(dá)式或者參數(shù)要分成多行進(jìn)行書寫呜呐,長(zhǎng)表達(dá)式要在低優(yōu)先級(jí)操作符處劃分新行就斤,操作符放在新行之首:
//old
if(condition1 && condition2 && condition3){
}
//new
if(condition1
&& condition2
&& condition3){
}
3.空行分割
相對(duì)獨(dú)立的程序塊、變量蘑辑、函數(shù)之間必須加空行洋机。有關(guān)聯(lián)的代碼緊湊在一起,相對(duì)無關(guān)的代碼需要一個(gè)空行分離洋魂。
4.數(shù)據(jù)與函數(shù)的排布
類屬性和類方法不要交叉放置绷旗,不同存取范圍的屬性或者方法也盡量不要交叉放置。
class{
類的公有屬性定義
類的保護(hù)屬性定義
類的私有屬性定義
類的公有方法定義
類的保護(hù)方法定義
類的私有方法定義
}
二.注釋
1.類注釋
類和接口的注釋放在class或者interface關(guān)鍵字之前副砍,import關(guān)鍵字之后衔肢。注釋主要是一句話概括功能。類的注釋使用如下:
/**
* 一句話功能簡(jiǎn)述
*/
2.函數(shù)的注釋
共有和保護(hù)方法注釋需要列出方法的一句話簡(jiǎn)述豁翎、輸入?yún)?shù)角骤、輸出參數(shù)、返回值等心剥。
/**
*功能簡(jiǎn)述
*@param 參數(shù)1:參數(shù)1說明
*@param 參數(shù)2:參數(shù)2說明
* return 返回值
*/