PostgreSQL 格式化

2021-08-24 14:26 更新

源代碼格式化使用 4 列制表間隔,并且保留制表符(即制表符不會被擴展成空格)。每一個邏輯縮進層就是一個額外的制表位。

布局規(guī)則(括號定位等)遵循 BSD 習(xí)慣。特別地,if、whileswitch等受控塊的花括號要獨自占據(jù)一行。

限制行長度,這樣在 80 列窗口中代碼也是可讀的(這并不意味著你不能超過 80 列。例如,為了保持代碼在 80 列以內(nèi)而在任意位置打斷一段長的錯誤消息字符串可能不會給可讀性帶來什么好處)。

要保持一致的編碼風(fēng)格,請勿使用C++風(fēng)格注釋(// comments)。pgindent 會用 /* ... */替換它們。

多行注釋塊更好的風(fēng)格是

/*
 * 注釋文本從這里開始
 * 延續(xù)到這里
 */

注意從列 1 開始的注釋塊將被pgindent原樣保留,但是它將重新對縮進的注釋塊斷行,好像它們是純文本一樣。如果你想要保留一個縮進塊中的換行,可以像這樣增加破折號:

    /*----------
     * 注釋文本從這里開始
     * 延續(xù)到這里
     *----------
     */

雖然在提交補丁時并不是一定要遵守這些格式化規(guī)則,但是最好能遵守。在下一次發(fā)行前你提交的代碼將會通過pgindent,因此使用某種其他格式化習(xí)慣無法使代碼被編排得很好。對于補丁,一種比較好的經(jīng)驗規(guī)則是讓新代碼看起來像它周圍的原有代碼

src/tools目錄包含有可以用于emacs、xemacs或者vim編輯器的設(shè)置文件,它們可以幫助確保這些編輯器會根據(jù)上述習(xí)慣格式化代碼。

可以這樣調(diào)用文本瀏覽工具moreless

more -x4
less -x4

來讓它們以合適的方式顯示制表符。

以上內(nèi)容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號