Google 開源項目風格指南

http://zh-google-styleguide.readthedocs.org/en/latest/

Google 開源項目風格指南 (中文版)

• 在線文檔託管在 ReadTheDocs : 在線閱讀最新版本
• 中文風格指南 GitHub 託管地址：zh-google-styleguide

Note

聲明.

本項目並非 Google 官方項目, 而是由國內程序員憑熱情創建和維護.

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

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

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

我們已經發布了四份 中文版 的風格指南:

1. Google C++ 風格指南
2. Google Objective-C 風格指南
3. Google Python 風格指南
4. Google JSON 風格指南

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

• 英文版項目還包含 cpplint - 一個用來幫助適應風格準則的工具, 以及 google-c-style.el, Google 風格的 Emacs 配置文件.
• 另外, 招募自願者翻譯 JavaScript Style Guide 以及 XML Document Format Style Guide, 有意者請聯繫 brantyoung.