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

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

  • 程序塊要采用縮進風(fēng)格編寫,縮進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;

應(yīng)如下書寫:

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

應(yīng)如下書寫:

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

應(yīng)如下書寫:

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

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

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

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

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

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

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

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

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

最后

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

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

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

友情鏈接更多精彩內(nèi)容