黑马程序员技术交流社区

标题: Java培训浅谈代码规范 [打印本页]

作者: 庭院深深深几许 时间: 2019-4-18 15:29
标题: Java培训浅谈代码规范
1.公用的内容放在一个文件中
你能想象要在系统顶部加一个修改密码的功能要修改四个页面吗?四个模块就有四个header.jsp，本来可以共用的东西却硬生生的被复制了四份，现在不是按照文件数量计算绩效的时候，所以能共用的就放在一个文件里面共用吧。
2.请不要引入多余js或者css文件
你能想象改了一个页面引入的css样式其他页面的样式整个就炸了是什么感觉吗?你能想象一个页面总是莫名其妙的加载多次是什么感觉吗?当我看到firebug中加载的一个一个的css文件和js文件后，I want to die.
3.无用的注释请删掉，错误的注释请改掉
你能想象当你打开好几个文件发现文件头的注释一模一样的感觉吗?当你想根据注释辨别这个文件是干嘛的，但是发现注释和文件压根儿不是一回事儿的时候，我不想去死，我想提刀砍人，就算您的类是拷贝过来的，请改一下注释好吗?这真的不需要耽误你一天的时间。
4.不用的方法请删除
市场需求大，Java培训越好越火。某日在打开某类时看到两个长的差不多的方法，分别名曰method1和method2，观其内容只有那么几行不同，遂问其作者，答曰：method1已不使用，现在用的是method2，回来后我直接将method1删除掉，然后去掉了method2的2，不用的方法请删掉，不然容易让人误解。
除了以method1234作为方法的迭代外，还有另外一种，你能体会打开一个类，从上往下好几百行都是单行注释的感觉吗?当翻到800行时才看到了一个方法，一个800行的类，就只有那么几行有用的代码，Are you kidding me?注释掉的方法删掉不好吗?保持清清爽爽的感觉不好吗?
5.不用的变量请删除
你能体会打开一个类看到满满的黄色警告是什么感觉吗?楼主是处女座，犯有强烈的强迫症，看到这个想把这个类给干掉，但是又不能，只能一个警告一个警告的看下去，把不用的变量删除掉，看着没有警告的类瞬间满足感爆棚，还是那句话，现在不是按照代码行数计算绩效的时代了，不用的变量请删除掉吧。
6.请记得单一职责
我们经常在说开发请遵从6大原则，先不说后面的什么迪米特法则、什么依赖倒置原则，一个单一原则就能玩死很多人包括楼主自己，单一原则要求一个类一个方法仅仅负责一件事情，但是你体会过一个方法利用ifelse完成多个功能的吗?好吧，我承认，这些功能都在操作一张数据库表，而且这些功能也很简单，但是我在看一个功能的时候突然蹦出来了一堆判断语句，我还不知道这些判断语句是干嘛的，如果不问原作者，谁知道呢?我可以理解开发周期紧，能省事就省事，但是请记得单一职责原则。
6.变量命名和方法命名
在不看方法体的情况下谁能告诉我upd()方法是干嘛用的，我不知道，看了方法体我才知道这是个修改的方法，好吧，我承认任务重时间紧压力大，但是您好歹把update写完吧，这样即使我不知道你要修改的是什么，但是至少我知道你这个是个修改的方法，如果您一时忘了update这个单词怎么写而又没有时间去查翻译，请在方法上面写上注释好吗?
变量的命名，请给您的变量起一个有意义的名字，诸如s/asd/aa/ss/string这样的变量名请停止使用吧，这只会给修改代码的人带来无尽的烦恼，甚至想给你邮寄一把菜刀，这里我还是要提一下时间紧任务重压力大的问题，在这种环境下能完成任务就不错了，哪里还顾得命名是什么呢?但是我想说的是查一个单词真的不需要一个小时甚至一天。

传智Java培训拥有6大课程优势——http://www.itcast.cn/javaee/
①独有的一站式IT职业教育体系，让学员通过6个月的线下学习实现高起点就业， 12个月的线上在职进阶课实现升职加薪，大幅提升学员的职场晋升速度。
②60+套技术解决方案，覆盖职场常见开发问题，让学员就业后快速上手开发难题，轻松成为核心员工。
③超大项目库，覆盖7大就业主流热门行业，让学员边学习边积累项目开发经验。
④超千人投入的3大课程研发库，每年耗资千万打造领先行业的优质课程。
⑤传智&华为课程共建，持续为课程输出前沿技术。
⑥120+超强师资团队，多为总监、架构师出身，除了专业技能，还为你规划适合你的职业发展路线。

欢迎光临黑马程序员技术交流社区 (http://bbs.itheima.com/)

黑马程序员IT技术论坛 X3.2