Java易忽略的编码规范

入职后不少小伙伴会发现公司编码规范与学校中的编码习惯在细节方面有较大的不同。今天我总结几点我自己在大学编码过程中的不符合编码规范或是需要注意的地方。(注:部分在学校编码过程中就已强调的规范就不再论述了)

命名格式

严禁使用拼音与英文混合进行命名

所有编程相关的命名严禁使用拼音或拼音与英文混合的方式,更不允许直接使用中文的方式。正确的英文拼写和语法可以提高易读性。注意,纯拼音命名方式要避免但部分国际通用的拼音可以使用,例如taobao、 hangzhou。

接口类中的方法和属性不要加任何修饰符

接口类中的方法和属性不要加任何修饰符号(包括public)。

严禁语义不明的缩写

缩写必须规范,严禁语义不明的缩写。入职后编写的代码不仅仅要给自己看懂,同时也要让其他人也能轻易看懂,不恰当的缩写会容易引起工作上的问题,必须规范缩写,即使不缩写也不要错误缩写。

代码格式

空格问题

1)左小括号和右边相邻字符之间不出现空格;
2)任何二目、三目运算符的左右两边都需要加一个空格
3)右小括号和左边相邻字符之间也不出现空格;
4)左大括号前需要加一个空格。
5)if/for/while/switch/do等保留字与括号之间需要加一个空格
6)注释的双斜线与注释内容之间需要加一个空格
7)方法参数在定义和传入时,多个参数逗号后面必须加一个空格

大括号换行问题

若大括号内为空,写为{}即可,大括号中间无需换行和空格,若代码块不为空则:
1)左大括号前不换行;
2)左大括号后换行;
3)右大括号前换行;
4)右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行;

缩进与换行问题

1)采用4个空格缩进,禁止使用Tab字符,如果使用Tab缩进,必须设置1个Tab为4个空格;
2)每行字符数限制不超过 120 个(不一定刚好是120个但不能超过120个,具体根据换行要求而定),超出需要换行,换行时遵循如下原则:
a.第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进,参考示例;
b. 运算符与下文一起换行;
c.方法调用的点符号与下文一起换行;
d.方法调用中的多个参数需要换行时,在逗号后进行;
e.在括号前不要换行;
3)IDE 的 text file encoding 设置为 UTF-8; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式;
4)单个方法的总行数不超过 80 行,提高代码的可读性,增强代码的可复用性且便于代码的维护;
5)不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性。不需要添加多个空行;
我们在大学期间编程常接触且违反的规范大都属于这几条。除了我提到的几点还有其它许多的规范需要我们学习。
还有一点,注释,在大学期间编写的代码我们的注释往往的稀少且不准确的(甚至于根本就不写注释),以后我们参与的项目的代码动辄几万行,必须规范注释的书写,
送你们这样一句话,‘‘写代码的最烦写注释,看代码的最烦不写注释。’’但记得你还是看的代码比较多,所以还是好好写注释吧!!!

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值