优秀的Java程序员的编程风格是什么

时间：2017-08-25 17:35
发布：达内
来源：达内
分享到：

今天突发奇想，对编码习惯和编程风格很感兴趣，于是乎，找了一下关于编程风格（Java篇）的资料，希望对爱好编码或者开始学习编码的同学有帮助！

好处不多说了，但是有几个原则如下：

1.保持原有风格
2.坚持最小惊奇原则
3.第一次就做对
4.记录所有非规范行为

格式规范：

1.缩进嵌套的代码：在每个代码块和嵌套中加入缩进，缩进代码，加强可读性。这些地方包括【类定义，内部类定义，方法定义，静态块，for循环语句，if-else语句，try、catch和finally块，匿名内部类，while语句，do-while语句】
2.断开很长的句子：第一，如果包含了逗号，那么在每一个逗号后面都另起一行，把逗号后面的每一个表达式都和逗号前面的表达式的第一个字母对齐。第二，应该在优先级最低的运算符之前断行。
3.使用空白：关键字和左括号之间，右括号和紧随其后的关键字，除了”.”之外的运算符与其前后的表达式之间用空格隔开。每个逻辑上独立的方法和代码段之间，定义类或者接口的成员之间，每个类和接口之间应该加入空白行。
4.不要直接使用Tab控制符：不同环境对Tab控制符的解释也是不同的。

命名约定：

1.名称应该具有实际意义
2.使用人们熟悉的名称
3.谨慎使用过长的名字，可以使用简明通用的缩写
4.尽量保留元音字母
5.缩写词的第一个字母大写
6.不要使用大小写来区分的名字

包命名：
1.用你所在组织的域名的倒序小写形式作为包的根限定词
2.使用单独的小写词作为每个包的根名
3.仅当新旧版本二进制兼容的时候，其包可以使用相同的名字，否则，请使用新名字

类型命名：
1.类和接口名中的每个单词的第一个字母大写

类命名：
1.用名词命名类
2.具有成组相关属性，静态服务或者常量的类名字使用复数形式

接口命名：
1.用名词或者形容词命名接口

方法命名：
1.方法名中的第一个单词小写，其后每个单词的第一个字母大写
2.用动词命名方法
3.遵循JavaBean中命名属性访问函数方法：set，get，is

变量命名：
1.变量命中的第一个单词小写，其后的每个单词的第一个字母大写
2.用名词命名变量
3.集合引用名要用复数形式
4.为不重要的临时变量简历并使用一套标准名字

字段命名：
1.使用this字段变量可以区分开局部变量

参数命名：
1.构造函数或者”set”方法给字段分配参数赋值，参数名应该和字段名相同

常量命名：
1.常量的每个单词均大写，单词之间使用下划线连接

文档约定：

1.为使用和维护你的代码的人编写文档
2.注释和代码要同步
3.使用积极的语气，省略无用的词语

注释类型：

1.用文档注释来描述编程接口
2.用标准注释格式隐藏代码而不必删除它们
3.用单行注释解释实现细节

文档注释：
1.在编写代码前描述编程接口
2.为公用，受保护，包，私有成员建立文档
3.为每个包编写总结和概述
4.为包的每个应用程序或组编写概述

注释风格：
1.对所有文档注释使用统一的格式和组织结构
2.关键字，标识符和常量应放到<code>…</code>标签中
3.将代码放入<pre>…</pre>标签中
4.在标识符第一次出现的时候用{@link}标签
5.为Javadoc标签简历并使用一套固定的顺序
6.使用第三人称叙述的形式
7.编写独立的概述
8.省略概述中动作和服务的主语
9.省略事物概述中的对象和动词
10.使用this而不是the来指代当前类中的实例
11.方法名或者构造函数名不需圆括号，除非你想突出一个特殊的签名

注释内容：
1.每个类、接口、字段和方法都编写概述
2.完整描述每个方法的签名
3.包含示例
4.为前置、后置、不变条件编写文档
5.为已知的缺陷和不足编写文档
6.为同步语法编写文档

内部注释：
1.仅添加有助于理解你的代码的内部注释
2.描写代码为什么这样做，而不是在做什么
3.避免使用行尾注释
4.用行尾注释解释局部变量声明
5.建立并使用一套关键词来标识尚未解决的问题
6.在嵌套程度高的控制结构中标记出嵌套结束位置
7.如果两个case标记之间没有break语句，就在中间加入“fall-through”注释
8.标记空语句