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 holds the C++ Style Guide, Objective-C Style Guide, Java Style Guide, Python Style Guide, R Style Guide, Shell Style Guide, HTML/CSS Style Guide, JavaScript Style Guide, AngularJS Style Guide, Common Lisp Style Guide, and Vimscript Style Guide. This project also contains cpplint, a tool to assist with style guide compliance, and google-c-style.el, an Emacs settings file for Google style.
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 guides live outside of this project: Go Code Review Comments and Effective Dart.
为了增加代码的「美感」, 进行了部分定制。
修改 intellij-java-google-style.xml 中的内容:
| 项 | 原始取值 | 定制之后 | 定制时间 | 备注 |
|---|---|---|---|---|
INDENT_SIZE |
2 | 4 | 20180731 | 行缩进 |
TAB_SIZE |
2 | 4 | 20180731 | TAB 缩进 |
CONTINUATION_INDENT_SIZE |
2 or 4 | 8 | 20180731 | 换行缩进 |
RIGHT_MARGIN |
100 | 120 | 20180731 | 单行的长度 |
JD_PRESERVE_LINE_FEEDS |
无 | true | 20180731 | 注释中, 保留手动的换行 |
KEEP_LINE_BREAKS |
无 | true | 20180731 | Java 代码中, 保留手动的换行 |
