专栏首页eguid开源技术分享Java代码编写规范(不是标准规范,自行整理,无须纠结)

Java代码编写规范(不是标准规范,自行整理,无须纠结)

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。

本文链接:https://blog.csdn.net/eguid_1/article/details/51577103

最近回过头来给以前的项目增加功能,发现之前写的注释非常不全,代码也非常的不整洁,有些地方写的‘’窝七八烂的,看着很不舒服;又恰好经理最近也经常跟我提起代码规范,我们就讨论了一下代码规范的重要性和必要性,于是决定我们也要制定个规范,这样利于团队开发,统一代码风格,写出来的代码也不会风格迥异;

最近几天有空就跟其他公司的盆友聊起这件事,越发觉得代码规范的必要性,于是根据其他公司盆友以及自己整理的一些细节制定了一套规范,作为公司团队开发的代码规范。

代码编写一些规范

首先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字符

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • HTTP/1.1 协议Expect: 100-continue

    CURL transport error: transfer closed withoutstanding read data remaining

    随心助手
  • iOS实现UITableViewDataSource与Controller的分离

    在之前的项目中好多处用到了tableView,然而之前不懂得将代理方法实现分离,所以每在一处用到tableView就要在controller中写一遍UITabl...

    周希
  • 译文:Nginx多阶段处理HTTP请求

    原文:http://www.nginxguts.com/2011/01/phases/

    随心助手
  • Nginx下游网速优先

    ngx_http_upstream_process_non_buffered_request()

    随心助手
  • nginx正向代理配置详解

    nginx不仅可以做反向代理,还能用作正向代理来进行上网等功能。如果把局域网外的Internet想象成一个巨大的资源库,则局域网中的客户端要访问Inte...

    随心助手
  • nginx之rewrite详解2-企业级应用场景

    (2)为了让搜索引擎搜录网站内容及用户体验更好,企业会将动态URL地址伪装成静态地址提供服务。

    随心助手
  • 某CMS最新版后台漏洞

    file_unlink("../../".list[info]); 这个点很有意思,list[info]从数据库met_plist表里读出,然后删除文件

    随心助手
  • 禁用Compiz,太占内存

    https://zh.wikipedia.org/wiki/Compiz ,简单理解是实现了Ubuntu的3D效果

    随心助手
  • nginx十万并发配置(1)

    1)nginx进程数,建议按照cpu数目来指定,一般跟cpu核数相同或为它的倍数。

    随心助手
  • nginx的11个阶段概述

    // 将请求URI与location表达式匹配前,修改URI,即重定向阶段

    随心助手

扫码关注云+社区

领取腾讯云代金券