原始碼格式化使用 4 個欄位的 Tab 間距,並保留 Tab 鍵 (也就是說,Tab 鍵不會展開為空格)。每個邏輯縮排層級是一個額外的 Tab 鍵位置。
版面配置規則 (大括號位置等) 遵循 BSD 慣例。特別是,if
、while
、switch
等的控制區塊的大括號會放在自己的行上。
限制行長度,以便程式碼可以在 80 欄的視窗中讀取。(這並不意味著您絕不能超過 80 欄。例如,為了使程式碼保持在 80 欄之內,而隨意中斷長錯誤訊息字串可能無法提高可讀性。)
為了保持一致的編碼風格,請勿使用 C++ 風格的註解 (//
註解)。 pgindent 會將其替換為 /* ... */
。
多行註解區塊的首選樣式是
/* * comment text begins here * and continues here */
請注意,從第 1 欄開始的註解區塊將由 pgindent 原封不動地保留,但它會將縮排的註解區塊重新流動,如同它們是純文字一樣。如果您想要保留縮排區塊中的分行符號,請新增破折號,如下所示
/*---------- * comment text begins here * and continues here *---------- */
雖然提交的修補程式不一定必須遵循這些格式化規則,但最好還是這樣做。您的程式碼會在下一個版本發佈之前,透過 pgindent 執行,因此沒有理由使其在其他格式化慣例下看起來很漂亮。修補程式的一個好的經驗法則是 “讓新程式碼看起來像它周圍的現有程式碼”。
src/tools/editors
目錄包含範例設定檔,可用於 Emacs、xemacs 或 vim 編輯器,以協助確保它們根據這些慣例格式化程式碼。
如果您想在本地執行 pgindent 以協助使您的程式碼符合專案風格,請參閱 src/tools/pgindent
目錄。
文字瀏覽工具 more 和 less 可以以下列方式調用
more -x4 less -x4
使它們適當地顯示 Tab 鍵。
如果您在文件中看到任何不正確、與您使用特定功能的經驗不符或需要進一步澄清的地方,請使用 此表單來報告文件問題。