document/zh-google-styleguide
2
0
Fork 0
mirror of https://github.com/zh-google-styleguide/zh-google-styleguide.git synced 2024-10-22 20:10:08 +08:00
Code Issues Packages Projects Releases Wiki Activity
Google 开源项目风格指南 (中文版)
180 Commits 1 Branch 6 Tags 9.9 MiB
Makefile 39.6%
Batchfile 38.7%
Python 21.7%
fe1f468a3b
Go to file
Bean Zhang fe1f468a3b Update README.rst and the contents of Python 
Because of the adding of Shell Style Guide,
the total number becomes five.

Modify the contents of Python Style Guide,
make it consistent with others.
2016-03-21 09:32:59 +08:00
google-cpp-styleguide 添加缺失的内容 2016-02-09 11:49:13 +08:00
google-html-css-styleguide edit parting_words 2013-05-27 17:56:07 +08:00
google-javascript-styleguide Update javascript_style_rules.rst 2014-06-26 15:54:23 +08:00
google-objc-styleguide 更新联系信息 2015-08-02 12:09:45 +08:00
google-python-styleguide Update README.rst and the contents of Python 2016-03-21 09:32:59 +08:00
google-shell-styleguide Add Google Shell Style Guide 2016-03-19 19:44:56 +08:00
.gitignore 使用 Read the Docs 主题 2015-08-02 12:52:12 +08:00
conf.py 使用 Read the Docs 主题 2015-08-02 12:52:12 +08:00
contents.rst Add Google Shell Style Guide 2016-03-19 19:44:56 +08:00
index.rst merge index.rst and README.rst 2012-08-16 09:40:36 +08:00
make.bat switch to github 2012-07-17 12:45:38 +08:00
Makefile switch to github 2012-07-17 12:45:38 +08:00
README.rst Update README.rst and the contents of Python 2016-03-21 09:32:59 +08:00

README.rst

Google 开源项目风格指南 (中文版)

Note

声明.

本项目并非 Google 官方项目, 而是由国内程序员凭热情创建和维护.

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

每个较大的开源项目都有自己的风格指南: 关于如何为该项目编写代码的一系列约定 (有时候会比较武断). 当所有代码均保持一致的风格, 在理解大型代码库时更为轻松.

"风格" 的含义涵盖范围广, 从 "变量使用驼峰格式 (camelCase)" 到 "决不使用全局变量" 再到 "决不使用异常". 英文版项目维护的是在 Google 使用的编程风格指南. 如果你正在修改的项目源自 Google, 你可能会被引导至 英文版项目页面, 以了解项目所使用的风格.

我们已经发布了五份 中文版 的风格指南:

  1. Google C++ 风格指南
  2. Google Objective-C 风格指南
  3. Google Python 风格指南
  4. Google JSON 风格指南
  5. Google Shell 风格指南

中文版项目采用 reStructuredText 纯文本标记语法, 并使用 Sphinx 生成 HTML / CHM / PDF 等文档格式.