StarMirror/styleguide
1
0
Fork 0
mirror of https://github.com/google/styleguide.git synced 2024-03-22 13:11:43 +08:00
Code Issues Projects Releases Wiki Activity

Updated README.md for easy undersanding

Browse Source
This commit is contained in:
Oluwafemi Tomilola 2023-09-02 04:18:05 +01:00 committed by GitHub
parent 718ea5d9f8
commit c8301f2eeb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

53
README.md
View File

@ -1,52 +1,53 @@
# Google Style Guides # Google Style Guides 📝
Every major open-source project has its own style guide: a set of conventions 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 (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 easier to understand a large codebase when all the code in it is in a consistent
style. style. ✨
“Style” covers a lot of ground, from “use camelCase for variable names” to “Style” covers a lot of ground, from "use camelCase for variable names" to
“never use global variables” to “never use exceptions.” This project "never use global variables" to "never use exceptions." This project
([google/styleguide](https://github.com/google/styleguide)) links to the style ([google/styleguide](https://github.com/google/styleguide)) links to the style
guidelines we use for Google code. If you are modifying a project that 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 originated at Google, you may be pointed to this page to see the style guides
that apply to that project. that apply to that project.
👇 Here are some of the style guides provided:
* [AngularJS Style Guide][angular] * [AngularJS Style Guide][angular] 🅰️
* [Common Lisp Style Guide][cl] * [Common Lisp Style Guide][cl] 🪙
* [C++ Style Guide][cpp] * [C++ Style Guide][cpp] 🖥️
* [C# Style Guide][csharp] * [C# Style Guide][csharp] 🤖
* [Go Style Guide][go] * [Go Style Guide][go] 🚀
* [HTML/CSS Style Guide][htmlcss] * [HTML/CSS Style Guide][htmlcss] 🌐
* [JavaScript Style Guide][js] * [JavaScript Style Guide][js] 📜
* [Java Style Guide][java] * [Java Style Guide][java] ☕
* [Objective-C Style Guide][objc] * [Objective-C Style Guide][objc] 🍎
* [Python Style Guide][py] * [Python Style Guide][py] 🐍
* [R Style Guide][r] * [R Style Guide][r] 📊
* [Shell Style Guide][sh] * [Shell Style Guide][sh] 🐚
* [Swift Style Guide][swift] * [Swift Style Guide][swift] 🏎️
* [TypeScript Style Guide][ts] * [TypeScript Style Guide][ts] 🌐
* [Vim script Style Guide][vim] * [Vim script Style Guide][vim] ✒️
This project also contains [cpplint][cpplint], a tool to assist with style guide This project also contains [cpplint][cpplint] 🚀, a tool to assist with style guide
compliance, and [google-c-style.el][emacs], an Emacs settings file for Google compliance, and [google-c-style.el][emacs] 📝, an Emacs settings file for Google
style. style.
If your project requires that you create a new XML document format, the If your project requires that you create a new XML document format, the
[XML Document Format Style Guide][xml] may be helpful. In addition to actual [XML Document Format Style Guide][xml] 📄 may be helpful. In addition to actual
style rules, it also contains advice on designing your own vs. adapting an style rules, it also contains advice on designing your own vs. adapting an
existing format, on XML instance document formatting, and on elements vs. existing format, on XML instance document formatting, and on elements vs.
attributes. attributes.
The style guides in this project are licensed under the CC-By 3.0 License, which The style guides in this project are licensed under the CC-By 3.0 License, which
encourages you to share these documents. See encourages you to share these documents. See
[https://creativecommons.org/licenses/by/3.0/][ccl] for more details. [https://creativecommons.org/licenses/by/3.0/][ccl] for more details. 📜
The following Google style guide lives outside of this project: The following Google style guide lives outside of this project:
[Effective Dart][dart]. [Effective Dart][dart] 🎯
## Contributing ## Contributing 🤝
With few exceptions, these style guides are copies of Google's internal style 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 guides to assist developers working on Google owned and originated open source
@ -55,7 +56,7 @@ first and eventually copied into the versions found here. **External
contributions are not accepted.** Pull requests are regularly closed without contributions are not accepted.** Pull requests are regularly closed without
comment. Issues that raise questions, justify changes on technical merits, or comment. Issues that raise questions, justify changes on technical merits, or
point out obvious mistakes may get some engagement and could in theory lead to 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. changes, but we are primarily optimizing for Google's internal needs. 🚧
<a rel="license" href="https://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a> <a rel="license" href="https://creativecommons.org/licenses/by/3.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/3.0/88x31.png" /></a>