Java語言編程規范——排版規范

對于排版的規范,可能大家很多都知道用ctrl+shift+f一鍵格式化,那么這個一鍵格式化遵循了什么樣的規則呢?當然很多公司也有自己的一個formatting.xml 格式化規范文件。今天我們就來具體了解下這個一鍵格式化到底包括哪些內容。

  • 程序塊要采用縮進風格編寫,縮進1個TAB鍵。
  • 較長的語句、表達式或參數(>120字符)要分成多行書寫,長表達式要在低優先級操作符處劃分新行,操作符放在新行之首,劃分出的新行要進行適當的縮進,使排版整齊,語句可讀。
    示例:
if (filename != null 
     && new File(logPath + filename).length() < LogConfig.getFileSize())
{
    ... // program code
}   
public static LogIterator read(String logType, Date startTime, Date endTime,
                                 int logLevel, String userName, int bufferNum)
  • 不允許把多個短語句寫在一行中,即一行只寫一條語句
    示例:如下例子不符合規范。
LogFilename now = null;        LogFilename that = null;

應如下書寫:

LogFilename now = null;
LogFilename that = null;
  • if, for, do, while, case, switch, default 等語句自占一行,且if, for, do, while等語句的執行語句無論多少都要加括號{}。
    示例:如下例子不符合規范。
if(writeToFile)           writeFileThread.interrupt();

應如下書寫:

if(writeToFile)
{
     writeFileThread.interrupt();
}
  • 相對獨立的程序塊之間、變量說明之后必須加空行。
    示例:如下例子不符合規范。
if(log.getLevel() < LogConfig.getRecordLevel())
{
    return;
}
LogWriter writer;

應如下書寫:

if(log.getLevel() < LogConfig.getRecordLevel())
{
     return;
}
//空一行
LogWriter writer;
int index;
  • 對齊只使用TAB鍵,不使用空格鍵。
  • 在兩個以上的關鍵字、變量、常量進行對等操作時,它們之間的操作符之前、之后或者前后要加空格。
    說明:采用這種松散方式編寫代碼的目的是使代碼更加清晰。
    示例:
    (1)逗號、分號只在后面加空格。
int a, b, c; 

(2)比較操作符, 賦值操作符"="、 "+=",算術操作符"+"、"%",邏輯操作符"&&"、"&",位域操作符"<<"、"^"等雙目操作符的前后加空格。

if (current_time >= MAX_TIME_VALUE) 
a = b + c;
a *= 2;
a = b ^ 2;

(3)"!"、"~"、"++"、"--"、"&"(地址運算符)等單目操作符前后不加空格。

flag =! isEmpty; // 非操作"!"與內容之間
i++;             // "++","--"與內容之間

(4)"."前后不加空格。

p.id = pid;     // "."前后不加空格

(5)if、for、while、switch等與后面的括號間應加空格,使if等關鍵字更為突出、明顯。

if (a >= b && c > d)
  • 類屬性和類方法不要交叉放置,不同存取范圍的屬性或者方法也盡量不要交叉放置。
    格式:
類定義
{
     類的公有屬性定義
     類的保護屬性定義
     類的私有屬性定義
     類的公有方法定義
     類的保護方法定義
     類的私有方法定義
}

最后

以上規范并不完整,歡迎大家補充。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 227,224評論 6 529
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 97,916評論 3 413
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 175,014評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,466評論 1 308
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,245評論 6 405
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 54,795評論 1 320
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 42,869評論 3 440
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,010評論 0 285
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,524評論 1 331
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,487評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,634評論 1 366
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,173評論 5 355
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 43,884評論 3 345
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,282評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,541評論 1 281
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,236評論 3 388
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,623評論 2 370

推薦閱讀更多精彩內容

  • 1. Java基礎部分 基礎部分的順序:基本語法,類相關的語法,內部類的語法,繼承相關的語法,異常的語法,線程的語...
    子非魚_t_閱讀 31,703評論 18 399
  • 一. Java基礎部分.................................................
    wy_sure閱讀 3,823評論 0 11
  • 原文: https://github.com/ecomfe/spec/blob/master/javascript...
    zock閱讀 3,386評論 2 36
  • 負能量朋友圈 拉黑拉黑拉黑! 其實按我的性子 我是很少拉黑人 除非是真的惹得我很嚴重 除了小便被拉黑是無辜的 有個...
    馬田心Martinc手作閱讀 211評論 2 2
  • 我的生活似乎被分成了兩半——平時和周末。在這不同的時間段里我似乎有這不一樣的表現,不一樣的性格,不一樣的控制...
    不知道0我是誰閱讀 1,060評論 0 1