styleguide README

The project's README from github.com/google/styleguide. As one markdown file: README.md.

Google Style Guides

Every major open-source project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (google/styleguide) links to the style guidelines we use for Google code. If you are modifying a project that originated at Google, you may be pointed to this page to see the style guides that apply to that project.

This project also contains google-c-style.el, an Emacs settings file for Google style.

We used to host the cpplint tool, but we stopped making internal updates public. An open source community has forked the project, so users are encouraged to use https://github.com/cpplint/cpplint instead.

If your project requires that you create a new XML document format, the XML Document Format Style Guide may be helpful. In addition to actual style rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes.

The style guides in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See https://creativecommons.org/licenses/by/3.0/ for more details.

The following Google style guide lives outside of this project:

Since projects are largely maintained in a VCS, writing good commit messages is important to long term project health. Please refer to How to Write a Git Commit Message as an excellent resource. While it explicitly refers to the Git SCM, its principles apply to any system, and many Git conventions are trivial to translate to others.

Contributing

With few exceptions, these style guides are copies of Google's internal style guides to assist developers working on Google owned and originated open source projects. Changes to the style guides are made to the internal style guides first and eventually copied into the versions found here. External contributions are not accepted. Pull requests are regularly closed without comment.

People can file issues using the GitHub tracker. Issues that raise questions, justify changes on technical merits, or point out obvious mistakes may get some engagement and could in theory lead to changes, but we are primarily optimizing for Google's internal needs.

Creative Commons License

styleguide (google/styleguide)

Searching Database…

39.7K ·GitHub
Styleguide
这是什么？这是 Google 为自家及源自 Google 的开源代码制定的一组风格指南，涵盖 C++、Java、Python、Go、JavaScript、TypeScript、HTML/CSS、Shell、Swift 等多种语言。
这是工具还是只是文档？这是纯文档，由一组相互链接的 Markdown/HTML 指南页面组成，另外附带一个 Emacs 配置文件，用于自动应用 Google 的 C++ 风格。
这个合集是怎么组织的？README 基本上是一个索引，链接到各语言的独立指南，包括 AngularJS、C++、C#、Go、HTML/CSS、Java、JavaScript、JSON、Markdown、Objective-C、Python、R、Shell、Swift、TypeScript、Vim script；Effective Dart 和 Kotlin 指南托管在外部。
要使用这里提到的 cpplint 工具，我需要额外准备什么吗？不需要。Google 已停止在内部维护 cpplint，现在引导用户改用社区分支，而不再在本仓库中托管。
它也涵盖提交信息的风格吗？它本身不定义提交信息的规范，但推荐了广受引用的文章 'How to Write a Git Commit Message' 作为参考资料。
有没有 XML 文档格式的指南？有的，提供 XML 文档格式风格指南，涵盖设计选择、实例文档的格式，以及元素与属性的使用。
Dart 和 Kotlin 的指南直接包含在这个仓库里吗？不包含。Effective Dart 和 Kotlin 风格指南由外部维护，本项目仅提供链接。
What are similar projects?zh-google-styleguide, ruby-style-guide, api-guidelines, project-layout, guide, idiomatic.js, swift-style-guide, nodebestpractices
Which topics is it in?angularjs, styleguide, standards, vim script, style-guide, c-sharp, coding, best-practices, programming, c#, golang, reference
Creator
google
Size
4.1 MB
Stars
39.7K
Updated
CommitOct 17
Age
11y
Commits · 90 Days