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

Go to file

TinkerRobot 803dffa932 🚧 TypeScript style guide: introduction.		2021-08-08 04:02:04 +08:00
google-cpp-styleguide	Update headers.rst	2020-12-02 11:28:43 +08:00
google-html-css-styleguide	edit parting_words	2013-05-27 17:56:07 +08:00
google-javascript-styleguide	Fix Javascript guide generate html warning	2020-07-29 14:55:35 +08:00
google-objc-styleguide	Modify RST code-block syntax error	2019-03-20 16:07:14 +08:00
google-python-styleguide	修改了一些明显的格式错误	2020-11-04 14:46:51 +08:00
google-shell-styleguide	Merge pull request #110 from imba-tjd/patch-1	2020-08-13 22:16:40 +08:00
google-typescript-styleguide	🚧 TypeScript style guide: introduction.	2021-08-08 04:02:04 +08:00
.gitignore	🚧 TypeScript style guide: introduction.	2021-08-08 04:02:04 +08:00
conf.py	Update file config.py	2020-08-15 18:37:39 +08:00
contents.rst	🚧 TypeScript style guide: introduction.	2021-08-08 04:02:04 +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
manually-generate-pdf-document.md	doc: add new offline link in README	2020-11-18 17:19:05 +08:00
README.rst	Revise doc links in README.rst	2021-01-01 00:29:22 +08:00

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

Note

声明.

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

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

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

"风格" 的含义涵盖范围广, 从 "变量使用驼峰格式 (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.