Google 開源專案風格指南 (繁體中文版)

Note

聲明.

本專案並非 Google 官方專案,而是個人希望提供繁體中文的 Coding Style 文件而繁體化,感謝簡體中文的翻譯者。

在繁體化的過程中,此專案修改了兩岸差異的用語以及敘述方式,並針對目前英文版的修改再次進行翻譯,希望在持續修正的過程中,可以提供適合台灣本地參考的風格指南。

如果你關注的是 Google 官方英文版,請移步 Google Style Guide

每個較大的開源專案都有自己的風格指南: 關於如何為該項目編寫代碼的一系列約定 (有時候會比較武斷)。 當所有程式碼均保持一致的風格,在理解大型程式碼庫時更為輕鬆。

“風格” 的含義涵蓋範圍廣,從 “變量使用駝峰格式 (camelCase)” 到 “決不使用全局變量” 再到 “決不使用例外”。 英文版專案維護的是在 Google 使用的編程風格指南。如果你正在修改的專案源自 Google,你可能會被引導至 英文版專案頁面,以瞭解專案所使用的風格。

目前採用 reStructuredText 純文本標記語法, 並使用 Sphinx 生成 HTML / CHM / PDF 等文檔格式.