跳轉到內容

軟體工程師手冊/支援流程/編碼標準

來自華夏公益教科書,開放書籍,開放世界

以下是維基百科條目關於 編碼標準

編碼標準通常包含針對特定語言的一組約定。通常涵蓋的專案包括

  • 命名約定,包括
    • 名稱應該多描述性,多長,
    • 應該使用什麼大寫方案,以及
    • 字尾和字首約定是什麼。
  • 物理組織,例如定義應位於標頭檔案中。不要在一個檔案中包含多個類。
  • 結構約定,例如開啟和關閉大括號應位於同一列,如下所示:
{
    {
        // code in here
    }
}
  • 樣式指南,例如包含指標的類應具有虛擬解構函式。 包含此類標準的推理和參考非常有用。
  • 遺留程式碼指南,例如在編輯現有程式碼時,請遵循現有程式碼的編碼命名和結構約定。

命名約定

[編輯 | 編輯原始碼]

"始終、始終、始終使用好的、未縮寫的、拼寫正確的有意義的名稱。" -- c2: 有意義的名稱

流行的命名約定(命名格式)包括

  • ALL_UPPERCASE_WITH_UNDERSCORES
  • all_lowercase_with_underscores
  • CamelCase
  • uppercaseOnlyInTheMiddle
  • _UnderscorePrefixedCamelCase
  • Camel_Case_With_Underscores

關於命名約定的意外冗長對話,請參閱 c2: 下劃線與大寫和小寫變數命名; 維基百科:駝峰式大小寫; c2: 駝峰式大小寫; 以及 "下劃線與駝峰式大小寫".

進一步閱讀

[編輯 | 編輯原始碼]
華夏公益教科書