阿里巴巴Java开发规约插件

2023-11-09

代码规范的重要性

前不久很多公众号都在说因为代码规范性引起的血案,这事吧,我也没有太在意,好像后来证实根本不属实。但是,也说明了一个事情。代码规范真的很重要。
附带一下查询的结果,搜索关键字:码农因代码规范

图片

代码规范,真的很重要,很重要,很重要
你说重要吧,也没那么重要,我的看法是:人嘛,越帅越好。(当然,现在的我不奢求帅,只想掉头发的速度能再慢些。)

Alibaba Java Coding Guidelines 插件

github地址:

https://github.com/alibaba/p3c
你可以下载到idea、eclipse插件。我用的是Android Studio。当然就是下载的idea插件。相关安装操作就不说了。
安装使用说明:

https://github.com/alibaba/p3c/tree/master/idea-plugin

附上一张官方的安装图:

图片

实际案例

说归说,做归做。找了个功能打开来检查下,当你的代码不符合规范的时候,就会有一条线来提醒了。略有强迫症的我是会去看看原因的。

  • 注释文档
    当你的类没有注释的时候,特别是没有写作者的时候,我觉得这个作者是重点。要是代码出了问题,应该找不到人背锅吧

    图片

    图片

  • 如果代码注释了,可以从项目中移除
    如果被你注释的代码,是确定没有用的,那么建议你直接从项目中移除。

    图片

    图片

  • 如果注释是单行注释
    如果是单行注释,建议不要注释在代码的右边。

    图片

    图片

  • 抽象类的命名规范
    关于抽象类,命名规范。做到看名知意。

    图片

    图片

  • 抽象类里面的方法需要注释

    抽象类的方法,建议给个注释,不然只看基类是不知道这个方法的意图。

    图片

    图片

    当然还有其他的规范性,有个这个插件,我们不用刻意的去记忆,只要看到波浪线提示,那就去改正下,日积月累,代码也就规范了。

    一起进步

    如果你觉得,我写的东西对你帮助,那我会觉得很开心。如果你觉得我写的东西还需要改进,我很想听到你的建议。让我们一起进步吧。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

阿里巴巴Java开发规约插件 的相关文章

随机推荐

  • Linux——文件系统:目录组织结构、文件类型、文件权限等

    在Linux中 所有的设备都是文件 文件的类型是根据文件头字段来判断 而非文件的后缀名 Linux的文件系统 EXT4 索引式的文件系统 以EXT4文件系统格式化磁盘时 将磁盘分成三个区 1 superblock 记录文件系统的整体信息 包
  • 微信小程序 短信验证 功能的实现(附案例代码/前后端/直接用)

    模块效果展示 小程序界面 实现的功能 小程序端 请求获取短信验证码 两次请求之间间隔至少一分钟 填写必填内容后 才能提交表单 手机号合法性检验 后台 接前台请求后 通过阿里云发送短信 生成随机数字验证码 默认6位 收到提交的表单后 对验证码
  • 如何实现IM即时通信系统(一)

    在企业数字化建设过程中 如何与客户保持线上链接是重要的组成部分 而IM通信系统就属于数字化建设的基础设施 那么 如何实现一个符合企业需求的IM系统呢 采购当然是其中需要考虑的方式之一 但就我个人的经验来看 市面上好的IM厂商很稀少 因为IM
  • 哈希表(散列表)——C++数据结构详解

    目录 1 哈希表原理精讲 2 哈希链表算法实现 2 1哈希表数据结构定义 2 2哈希函数 2 3哈希链表初始化 2 4哈希链表查找函数 2 5哈希链表插入函数 2 6哈希链表删除元素 3 哈希表完整代码 哈希表 散列表 它是基于快速存取的角
  • [运放滤波器]4_积分微分电路

    动态系统的建模与分析 15 伯德图 bode图 为什么是20logM 分贝又是什么 动态系统的建模与分析 9 一阶系统的频率响应 低通滤波器 动态系统的建模与分析 8 频率响应 详细数学推导 G jw 滤波器 运放滤波器 3 反相同相比例放
  • java ssh连接_PuTTY 0.71 发布,开源的 SSH 和 Telnet 客户端

    PuTTY 最新版本 0 71 已发布 PuTTY 是一款集成虚拟终端 系统控制台和网络文件传输为一体的自由开源程序 它支持多种网络协议 包括 SCP SSH Telnet rlogin 和原始的套接字连接 它也可以连接到串行端口 其软件名
  • mysql 外连接总结

    原文 http blog sina com cn s blog 3d48dbb70100hyz4 html 了点时间总结了一下mysql中的内 外连接 转载注明 首先my sql 不支持oracle的 内连接 只连接匹配的行 左外连接 包含
  • 关于智能合约开发的真相

    就像 区块链 AI 和 云 这样的词语一样 智能合约 也是那些得到大量炒作的短语之一 毕竟 没有什么比不通过司法系统而让人们能够相信发生了什么更有意思的了 智能合约的承诺包括 自动 无须信任和公正地执行合约 在合约构建 合约执行和合约执行环
  • 狂神说 Docker笔记

    Docker概述 Docker为什么出现 Docker的思想来自于集装箱 JRE 多个应用 端口冲突 原来都是交叉的 隔离 Docker核心思想 打包装箱 每个箱子是互相隔离的 Docker通过隔离机制 可以将服务器利用到极致 Docker
  • ShardingSphere分库分表2-ShardingJDBC实战

    文章目录 一 ShardingSphere 二 ShardingJDBC实战 1 核心概念 2 测试项目介绍 3 快速实战 4 ShardingJDBC的分片算法 5 ShardingSphere的SQL使用限制 6 分库分表带来的问题 7
  • JAVA四大特征(抽象,封装,继承,多态)

    1 私有属性必须通过一个成员方法去控制和访问私有属性 2 访问控制修饰符 访问级别 访问控制修饰符 同类 同包 子类 不同包 公开 public 受保护 protected 默认 无 私有 private 3 继承 当多个类具有相同的属性
  • Oracle常见错误总结

    最近多次用到Oracle 主要就是导入dmp文件 然后将文件读出来并写进csv文件 在这过程中出现了一系列的问题 每次都几乎让我崩溃 一方面觉得Oracle用起来真麻烦 但是回过头想想 另一方面说明Oracle机制做的好 各种错误都能考虑到
  • MySQL学习笔记--菜鸟开始上路了!

    开篇话 用MySQL有一段时间了 但是发现自己没有系统的对SQL进行过深入学习 从这篇笔记开始对SQL进行系统学习 也希望和我情况一样的伙伴能够一起进步 学习前症状 状态适用 虽然顺利的把数据从库表中取出 但并不清楚它具体是怎样执行的 也不
  • LLVM系列第七章:函数参数Function Arguments

    系列文章目录 LLVM系列第一章 编译LLVM源码 LLVM系列第二章 模块Module LLVM系列第三章 函数Function LLVM系列第四章 逻辑代码块Block LLVM系列第五章 全局变量Global Variable LLV
  • Java 递归方法

    Java 递归方法 1 说明 定义 一个方法体内调用它自己 方法递归是一种隐式的循环 它会重复的执行某段代码 但这种重复执行无须循环控制 递归一定要向着已知的方向递归 否则这种递归就变成了无穷递归 类似于死循环 2 code 举例 publ
  • Redis7之哨兵(九)

    9 1介绍 哨兵巡查监控后台master主机是否故障 如果故障了根据投票数自动将某一个从库转换为新主库 继续对外服务 俗称无人值守运维 作用 监控redis运行状态 包括master和slave 当master down机 能自动将slav
  • VS2019 + Qt5.13 配置

    在安装完VS2019后 再安装Qt5 13选择安装msvc2017模块 再安装qt vsaddin插件 我选的是2 4版本 反正安装最新的也不会错 安装成功后 新建项目 发现问题 Entry Point Not Found 这是因为编译的版
  • python线程池 ThreadPoolExecutor

    python 线程池 ThreadPoolExecutor 实现步骤 代码实现 实现步骤 创建一个最大容纳数量为3的线程池 通过submit提交执行的函数到线程池中 通过done来判断线程是否完成 通过result来获取返回值 代码实现 c
  • VS code “密钥externalConsole已弃用,请改用console“的解决方法

    VS code 密钥 externalConsole 已弃用 请改用 console 的解决方法 原因 externalConsole 是旧版vscode cpp的密钥 决定输出和调试是在内部还是外部 新版vscode密钥已经改为 cons
  • 阿里巴巴Java开发规约插件

    代码规范的重要性 前不久很多公众号都在说因为代码规范性引起的血案 这事吧 我也没有太在意 好像后来证实根本不属实 但是 也说明了一个事情 代码规范真的很重要 附带一下查询的结果 搜索关键字 码农因代码规范 代码规范 真的很重要 很重要 很重