插件推荐:如何将Java编码规范落地实际开发中


标致枕头
标致枕头 2022-09-29 09:53:45 50959
分类专栏: 资讯

一个软件需要花费80%的生命周期成本去维护。

几乎没有任何软件的整个生命周期仅由其原作者来维护。

编码规范改善软件的可读性,让工程师更快更彻底地理解新的代码。

如果你将源代码转变为一个产品,那么您需要确保它和你创建的其它产品一样是干净且包装良好的。

借用《Java编程语言代码规范》一段开场白,也许就解释了我们为什么需要编码规范。

无规矩不成方圆,无规范不能协作。阿里近万名Java技术开发者通过不断总结与提炼,并经历了多次大规模一线实战检验及完善,出版了众所周知的《阿里巴巴Java开发手册》,希望使更多的开发者团队在Java开发上更高效、容错、有协作性,提高代码质量并降低维护成本,而手册也尽可能涵盖开发常见环节,包括编程规约、单元测试规约、异常日志规约、MySQL规约、工程规约、安全规约等。

但对于很多人而言,手册始终无法直接应用在日常的开发工作中,如果有相应的IDE插件进行支持,那简直完美。因此,Cloud Toolkit应运而生。

Cloud Toolkit 集成了 Java 代码检查功能。该功能基于《阿里巴巴 Java 开发手册》中的代码规约,执行 Java 代码的静态检查,帮助您在编译前快速发现代码异常,并提供修改建议。

前提条件

已安装 2019.11.1 或更高版本的 Cloud Toolkit 插件。安装方法请参见

执行代码检查在 IDE 的 Project 面板上左键单击要检查的工程文件,在弹出的菜单栏中选择 Alibaba Cloud > Coding Guidelines Check。

如果您不想检查整个工程,也可以在工程的文件目录中选中想要检查的目录,在右侧代码编辑区域的空白处单击鼠标左键,选择 Alibaba Cloud > Coding Guidelines Check,进行检查。

2.在工程的文件目录区域下方会出现 Inspection Results 面板,可在面板下方看到代码检查进度。

Cloud Toolkit 默认将检查出的错误按照严重程度从高到低分为 Blocker、Critical、Major。Blocker 程度的错误可能会影响代码的成功编译。

3.在 Inspection Results 面板的左侧区域显示错误信息目录。单击信息则右侧区域会显示错误代码,部分错误会提供快速修正建议,如下图中的标记 1 所示。

Inspection Results面板各区域功能说明如下。上图标记 2:错误信息目录的最下级节点的行末显示错误代码所在行数 line XX。双击该级节点,则位于Inspection Results面板上方的代码编辑区会定位到错误代码并高亮显示。

上图标记 3 区域内,从左至右,从上至下的按钮功能如下。Rerun Inspection:重新执行代码检查

Group by Severity:按照错误严重程度分组错误信息

Expand All:将错误信息目录展开至最下级

Group by Directory:按照目录分组错误信息

Collapse All:将错误信息目录收起至最上级

Filter Resolved Items:过滤掉以及修改完成的错误

Go Prev Problem:在错误目录区域移动至上一条错误

Autocsroll to Source:打开此功能,在错误目录区域单击错误信息时,代码编辑区自动跳转到错误代码

Go Next Problem:在错误目录区域移动至下一条错误

Export:将错误信息导出至本地,可选择导出为 HTML 或 XML 格式

Edit Settings:编辑错误代码检查的设置文件

Apply Quickfix:使用快速修正

您可以使用快速修正功能修正代码,也可以手动修改代码。

获取方式:

• IntelliJ IDEA版/PyCharm版本:

• Visual Studio Code版本:

• Eclipse 版本:

• Maven 版本:

使用教程:

网站声明:如果转载,请联系本站管理员。否则一切后果自行承担。

本文链接:https://www.xckfsq.com/news/show.html?id=10934
赞同 0
评论 0 条
标致枕头L0
粉丝 0 发表 7 + 关注 私信
上周热门
如何使用 StarRocks 管理和优化数据湖中的数据?  2944
【软件正版化】软件正版化工作要点  2863
统信UOS试玩黑神话:悟空  2823
信刻光盘安全隔离与信息交换系统  2717
镜舟科技与中启乘数科技达成战略合作,共筑数据服务新生态  1251
grub引导程序无法找到指定设备和分区  1217
华为全联接大会2024丨软通动力分论坛精彩议程抢先看!  163
点击报名 | 京东2025校招进校行程预告  162
2024海洋能源产业融合发展论坛暨博览会同期活动-海洋能源与数字化智能化论坛成功举办  160
华为纯血鸿蒙正式版9月底见!但Mate 70的内情还得接着挖...  157
本周热议
我的信创开放社区兼职赚钱历程 40
今天你签到了吗? 27
信创开放社区邀请他人注册的具体步骤如下 15
如何玩转信创开放社区—从小白进阶到专家 15
方德桌面操作系统 14
我有15积分有什么用? 13
用抖音玩法闯信创开放社区——用平台宣传企业产品服务 13
如何让你先人一步获得悬赏问题信息?(创作者必看) 12
2024中国信创产业发展大会暨中国信息科技创新与应用博览会 9
中央国家机关政府采购中心:应当将CPU、操作系统符合安全可靠测评要求纳入采购需求 8

加入交流群

请使用微信扫一扫!