Java代码编写规范(不是标准规范,自行整理,无须纠结)
2021/4/19 22:28:25
本文主要是介绍Java代码编写规范(不是标准规范,自行整理,无须纠结),对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
最近回过头来给以前的项目增加功能,发现之前写的注释非常不全,代码也非常的不整洁,有些地方写的‘’窝七八烂的,看着很不舒服;又恰好经理最近也经常跟我提起代码规范,我们就讨论了一下代码规范的重要性和必要性,于是决定我们也要制定个规范,这样利于团队开发,统一代码风格,写出来的代码也不会风格迥异;
最近几天有空就跟其他公司的盆友聊起这件事,越发觉得代码规范的必要性,于是根据其他公司盆友以及自己整理的一些细节制定了一套规范,作为公司团队开发的代码规范。
代码编写一些规范
首先Java实例三大原则:
1、必须实现序列化接口
2、必须有set/get方法
3、必须实现hash()/tostring()方法
普通规范:
4、字段方法命名必须满足驼峰命名规则,类名必须大写
5、文件、类、字段、方法(除了set/get方法)必须有注释
文件注释规范:
/**
* 文件名:xxx.java
* 描述:xxx
* 修改人:xxx
* 修改时间:20xx年xx月xx日
* 修改内容:
*/
类注释规范:
/**
* 〈一句话功能简述〉
* 〈功能详细描述〉
* @author xxx
* @version 20xx年xx月xx日
* @see xxx
* @since
*/
字段注释规范:
/**
*意义,目的和功能,以及被用到的地方
*/
方法注释规范:
/**
* 方法描述
* @param xxx
* 参数描述
* @param xxx
* 参数描述
* @return xxx
*/
6、equals()方法使用规范
必须采用字符串比较参数:"xxx".equals(xxx)
7、接收到的方法参数必须判断是否空值
8、字段和字段,方法和方法之间必须空一行
9、每个方法只实现一个功能
10、for循环不超过三层,if()条件判断不能超过三个
11、大括号位置要对称,不能出现大括号在语句后面的情况
if (a > b)
{
a = b;
}
12、关键字,运算符,变量等字段要空格,方便阅读
13、同一行语句不能太长,最长不超过130字符
这篇关于Java代码编写规范(不是标准规范,自行整理,无须纠结)的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-11-01后台管理开发学习:新手入门指南
- 2024-11-01后台管理系统开发学习:新手入门教程
- 2024-11-01后台开发学习:从入门到实践的简单教程
- 2024-11-01后台综合解决方案学习:从入门到初级实战教程
- 2024-11-01接口模块封装学习入门教程
- 2024-11-01请求动作封装学习:新手入门教程
- 2024-11-01登录鉴权入门:新手必读指南
- 2024-11-01动态面包屑入门:轻松掌握导航设计技巧
- 2024-11-01动态权限入门:新手必读指南
- 2024-11-01动态主题处理入门:新手必读指南