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

• 在線文檔托管在 ReadTheDocs : 在線閱讀最新版本 [http://zh-google-styleguide.readthedocs.org/]
• 中文風(fēng)格指南 GitHub 托管地址：zh-google-styleguide [https://github.com/zh-google-styleguide/zh-google-styleguide]

Note

聲明.

本項目并非 Google 官方項目, 而是由國內(nèi)程序員憑熱情創(chuàng)建和維護(hù).

如果你關(guān)注的是 Google 官方英文版, 請移步 Google Style Guide [http://code.google.com/p/google-styleguide/]

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

“風(fēng)格” 的含義涵蓋范圍廣, 從 “變量使用駝峰格式 (camelCase)” 到 “決不使用全局變量” 再到 “決不使用異?！?英文版項目維護(hù)的是在 Google 使用的編程風(fēng)格指南. 如果你正在修改的項目源自 Google, 你可能會被引導(dǎo)至英文版項目頁面, 以了解項目所使用的風(fēng)格.

我們已經(jīng)發(fā)布了四份 中文版 的風(fēng)格指南:

1. Google C++ 風(fēng)格指南 [http://zh-google-styleguide.readthedocs.org/en/latest/google-cpp-styleguide/]
2. Google Objective-C 風(fēng)格指南 [http://zh-google-styleguide.readthedocs.org/en/latest/google-objc-styleguide/]
3. Google Python 風(fēng)格指南 [http://zh-google-styleguide.readthedocs.org/en/latest/google-python-styleguide/]
4. Google JSON 風(fēng)格指南 [https://github.com/darcyliu/google-styleguide/blob/master/JSONStyleGuide.md]

中文版項目采用 reStructuredText 純文本標(biāo)記語法, 并使用 Sphinx 生成 HTML / CHM / PDF 等文檔格式.

• 英文版項目還包含 cpplint [http://google-styleguide.googlecode.com/svn/trunk/cpplint] - 一個用來幫助適應(yīng)風(fēng)格準(zhǔn)則的工具, 以及 google-c-style.el [http://google-styleguide.googlecode.com/svn/trunk/google-c-style.el], Google 風(fēng)格的 Emacs 配置文件.

• 另外, 招募自愿者翻譯 JavaScript Style Guide [http://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml] 以及 XML Document Format Style Guide [http://google-styleguide.googlecode.com/svn/trunk/xmlstyle.html], 有意者請聯(lián)系 brantyoung [http://yangyubo.com].

  ? Copyright . Created using Sphinx 1.3.1.