對于排版的規范,可能大家很多都知道用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)
- 類屬性和類方法不要交叉放置,不同存取范圍的屬性或者方法也盡量不要交叉放置。
格式:
類定義
{
類的公有屬性定義
類的保護屬性定義
類的私有屬性定義
類的公有方法定義
類的保護方法定義
類的私有方法定義
}
最后
以上規范并不完整,歡迎大家補充。