Java語言編程規(guī)范——排版規(guī)范

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

  • 程序塊要采用縮進風格編寫,縮進1個TAB鍵红且。
  • 較長的語句坝茎、表達式或參數(shù)(>120字符)要分成多行書寫,長表達式要在低優(yōu)先級操作符處劃分新行暇番,操作符放在新行之首嗤放,劃分出的新行要進行適當?shù)目s進,使排版整齊壁酬,語句可讀次酌。
    示例:
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)
  • 不允許把多個短語句寫在一行中恨课,即一行只寫一條語句
    示例:如下例子不符合規(guī)范。
LogFilename now = null;        LogFilename that = null;

應如下書寫:

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

應如下書寫:

if(writeToFile)
{
     writeFileThread.interrupt();
}
  • 相對獨立的程序塊之間吊宋、變量說明之后必須加空行纲辽。
    示例:如下例子不符合規(guī)范。
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)
  • 類屬性和類方法不要交叉放置酗洒,不同存取范圍的屬性或者方法也盡量不要交叉放置士修。
    格式:
類定義
{
     類的公有屬性定義
     類的保護屬性定義
     類的私有屬性定義
     類的公有方法定義
     類的保護方法定義
     類的私有方法定義
}

最后

以上規(guī)范并不完整妄迁,歡迎大家補充。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末李命,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子箫老,更是在濱河造成了極大的恐慌封字,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,682評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件耍鬓,死亡現(xiàn)場離奇詭異阔籽,居然都是意外死亡,警方通過查閱死者的電腦和手機牲蜀,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,277評論 3 395
  • 文/潘曉璐 我一進店門笆制,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人涣达,你說我怎么就攤上這事在辆。” “怎么了度苔?”我有些...
    開封第一講書人閱讀 165,083評論 0 355
  • 文/不壞的土叔 我叫張陵匆篓,是天一觀的道長。 經(jīng)常有香客問我寇窑,道長鸦概,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,763評論 1 295
  • 正文 為了忘掉前任甩骏,我火速辦了婚禮窗市,結果婚禮上,老公的妹妹穿的比我還像新娘饮笛。我一直安慰自己咨察,他們只是感情好,可當我...
    茶點故事閱讀 67,785評論 6 392
  • 文/花漫 我一把揭開白布缎浇。 她就那樣靜靜地躺著扎拣,像睡著了一般。 火紅的嫁衣襯著肌膚如雪素跺。 梳的紋絲不亂的頭發(fā)上二蓝,一...
    開封第一講書人閱讀 51,624評論 1 305
  • 那天,我揣著相機與錄音指厌,去河邊找鬼刊愚。 笑死,一個胖子當著我的面吹牛踩验,可吹牛的內容都是我干的鸥诽。 我是一名探鬼主播商玫,決...
    沈念sama閱讀 40,358評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼牡借!你這毒婦竟也來了拳昌?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,261評論 0 276
  • 序言:老撾萬榮一對情侶失蹤钠龙,失蹤者是張志新(化名)和其女友劉穎炬藤,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體碴里,經(jīng)...
    沈念sama閱讀 45,722評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡沈矿,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了咬腋。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片羹膳。...
    茶點故事閱讀 40,030評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖根竿,靈堂內的尸體忽然破棺而出陵像,到底是詐尸還是另有隱情,我是刑警寧澤犀填,帶...
    沈念sama閱讀 35,737評論 5 346
  • 正文 年R本政府宣布蠢壹,位于F島的核電站,受9級特大地震影響九巡,放射性物質發(fā)生泄漏图贸。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,360評論 3 330
  • 文/蒙蒙 一冕广、第九天 我趴在偏房一處隱蔽的房頂上張望疏日。 院中可真熱鬧,春花似錦撒汉、人聲如沸沟优。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,941評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽挠阁。三九已至,卻和暖如春溯饵,著一層夾襖步出監(jiān)牢的瞬間侵俗,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,057評論 1 270
  • 我被黑心中介騙來泰國打工丰刊, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留隘谣,地道東北人。 一個月前我還...
    沈念sama閱讀 48,237評論 3 371
  • 正文 我出身青樓啄巧,卻偏偏與公主長得像寻歧,于是被迫代替她去往敵國和親掌栅。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,976評論 2 355

推薦閱讀更多精彩內容

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