代码风格

Why

刚写代码时,编程规范只是我这个"高傲"程序猿(也可以说是无知无畏)的一种枷锁。所以,我的工作流程是:

STEP1.草草翻阅一遍编程规范
STEP2.边看边吐槽规范中拗口的语句
STEP3.实战中优先完成业务逻辑,编程规范靠边站
STEP4.用代码质量工具自动扫描出一堆问题,完成上线前QA的KPI要求

然而,代码质量工具只能无情地检测出"违反约定"的行为,却无法保证代码持续的"美不美"->时时刻刻的"美不美"

不美的后果是啥呢?
代码风格_第1张图片

所以,无论您有多牛,请无条件遵循某种编程规范
代码风格_第2张图片

如何有效阅读一份编程规范

引用一段google编程规范前言

This document serves as the complete definition of Google's coding standards for source code in the Java™ Programming Language. A Java source file is described as being_in Google Style_if and only if it adheres to the rules herein.

Like other programming style guides, the issues covered span not only aesthetic issues of formatting, but other types of conventions or coding standards as well. However, this document focuses primarily on the hard-and-fast rules that we follow universally, and avoids giving_advice_that isn't clearly enforceable (whether by human or tool).

其中,aesthetic(美学)和conventions(约定)是编程规范重点讨论的两个方面。
关于aesthetic,任何一份编程规范都会从命名排版注释三大维度来阐述。遵循这3个维度,就限定了阅读代码的美学体验。
这有点像平面设计,设计师定好字体、排版、文案内容,一份海报基本就成型了。

摘自—— 作品集排版套路大全 - 知乎专栏
代码风格_第3张图片

命名

无论哪个大厂、哪种语言的编程规范,对于命名本质上就在强调3点

语言的阵营特征

历史上出现的命名法包括:匈牙利命名法、驼峰式命名法、帕斯卡命名法、下划线命名法。不同语言阵营的命名法不同。感兴趣的小朋友可以看看这篇文章:四种基本的编程命名规范
Java选择的是驼峰式命名,驼峰式又分大驼峰、小驼峰。

语言的元素特征

Java的代码文件中包括如下几种语言元素:

  • 接口or抽象类
  • 类、枚举
  • 异常
  • 常量

每种语言元素要么选择大驼峰,要么选择小驼峰,要么选择全大写。

说人话

"人话"有2个标准:词能达意,简明扼要。
这一点完全看您的小学语文是不是体育老师教的。

排版

注释

学习《阿里编程规范》

学习《Google Java Style Guide》

你可能感兴趣的:(java,代码风格)