Google 開源項目風格指南(中文版)
- 在線文檔托管在 ReadTheDocs : 在線閱讀最新版本
- 中文風格指南 GitHub 托管地址:zh-google-styleguide
每個較大的開源項目都有自己的風格指南: 關于如何為該項目編寫代碼的一系列約定 (有時候會比較武斷). 當所有代碼均保持一致的風格, 在理解大型代碼庫時更為輕松.
“風格” 的含義涵蓋范圍廣, 從 “變量使用駝峰格式 (camelCase)” 到 “決不使用全局變量” 再到 “決不使用異常”. 英文版項目維護的是在 Google 使用的編程風格指南. 如果你正在修改的項目源自 Google, 你可能會被引導至英文版項目頁面, 以了解項目所使用的風格.
我們已經發布了四份 中文版 的風格指南:
中文版項目采用 reStructuredText 純文本標記語法, 并使用 Sphinx 生成 HTML / CHM / PDF 等文檔格式.
- 英文版項目還包含 cpplint - 一個用來幫助適應風格準則的工具, 以及 google-c-style.el, Google 風格的 Emacs 配置文件.
- 另外, 招募自愿者翻譯 JavaScript Style Guide 以及 XML Document Format Style Guide, 有意者請聯系 Yang.Y.
本文由用戶 d2dn 自行上傳分享,僅供網友學習交流。所有權歸原作者,若您的權利被侵害,請聯系管理員。
轉載本站原創文章,請注明出處,并保留原始鏈接、圖片水印。
本站是一個以用戶分享為主的開源技術平臺,歡迎各類分享!