简露一手-Java-eclipse 开发,简单实现统一项目代码格式,美化代码,解决代码冲突,避免覆盖

复杂的故事简单说,复杂的问题简单做,您好,这里是简露一手,欢迎浏览。

简述


经常:提交代码到SVN比对,发现代码被上一个提交的人整体格式化了,差异无法比对,提交后将别人代码覆盖,自己代码也被人覆盖。

时常:不熟悉项目或新人加入项目,新代码怎么都显得格格不入,说它的不对还没什么依据。

最后:代码样式、函数命名千奇百怪,伟大了一堆填坑的人。

代码格式

分析


对于项目研发管理上,积累越多,问题越凸显。这个问题简单列出就两点:

  • 缺少统一格式标准
  • 缺少检测机制

处理的方式很多,这里就推荐一种。统一格式用Eclipse里面Formatter和CodeTemplate;检测机制则推荐使用Eclipse 插件“checkStyle”。

处理


分三个步骤处理,分别是Formatter、CodeTemplate和CheckStyle的处理。

Formatter

Formatter我们用它定义代码格式,这个代码格式就包括变量命名、方法命名、方法行数,缩进字符数等格式,当然最简单的办法还是直接找一个模板,添加到eclipse中,要对现有模板进行修改,则点击“Edit”修改模板格式,修改后的格式记得导出给他人使用,以便保持所有人格式统一。


添加修改Formatter

CodeTemplate

CodeTemplate我们用来定义类、方法和变量的备注,也就是JavaDoc,类JavaDoc一般定义一个公司版权、创建时间和路径;方法JavaDoc、变量JavaDoc定义入参、出参格式还有创建人、UR等信息。最简单的办法:找一个现有模板,修改版权信息后导入到Eclipse中,要对现有模板修改,则点击“Edit”修改模板格式,修改后的格式记得导出给他人使用,以便保持所有人格式统一。


添加修改CodeTemplate

CheckStyle

checkStyle我们用它来做检测,检测代码格式是否符合标准。所以我们需要编写一个checkstyle格式文件,然后在Eclipse中用格式文件去进行代码格式校验。

  • 格式文件
    CheckStyle 格式文件编写,最简单的办法还是直接找一个CheckStyle模板,如果符合要求直接使用,不符合的地方做稍微调整,如果想对checkstyle全面了解,可以搜“checkstyle检查规则”


    checkstyle检查规则
  • 安装使用

CheckStyle非Eclipse自带,需要安装插件,在百度上搜索“checkstyle安装”能找到N种安装的方式。


CheckStyle安装

效果展示

  • 格式与标准不符时,CheckStyle会自动标红,告诉你哪里不对。


    checkStyle校验
  • 按Ctrl+Shift+F 自动按照标准格式化代码,按Alt+Shift+J自动生成方法的JavaDoc,CheckStyle标红处会消失。


    自动格式化

总结

定义Formatter、CodeTemplate,设置CheckStyle,好帮手、高质量、事半功倍,从这里开始。

<small>贴不了附件,需要Formatter、CodeTemplate、CheckStyle三个模板,请留言留下邮箱</small>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
【社区内容提示】社区部分内容疑似由AI辅助生成,浏览时请结合常识与多方信息审慎甄别。
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

相关阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 47,285评论 6 342
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 179,323评论 25 708
  • 1 背景 一个项目开发必然会涉及团队协作,而工程质量就需要团队去保证。一般我们期望的代码:无潜在风险、无重复逻辑、...
    zyl06阅读 3,297评论 5 16
  • 貘在日落之后醒来。 街灯在暗蓝的夜幕下浸出一团团橙红光晕,渐渐连绵成片,映红天宇。楼房窗户里亮着冷白的灯,远处望去...
    德鲁喵肥美多脂阅读 1,746评论 8 6
  • 01 创业与就业 创业意味着你需要投入所有的时间、精力甚至是金钱,你或将短暂的告别悠闲与浪漫,哪怕是下雨、下雪的早...
    鲁易斯阅读 496评论 0 0

友情链接更多精彩内容