简露一手-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>

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,098评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,213评论 2 380
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,960评论 0 336
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,519评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,512评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,533评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,914评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,574评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,804评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,563评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,644评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,350评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,933评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,908评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,146评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,847评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,361评论 2 342

推荐阅读更多精彩内容

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