代码综合提升
金玮良
勿忘初心
展开
-
整洁代码--写好注释
写在标题前:看了很多资料说“写注释是为了弥补代码表达意图时的失败”,的确有道理,好的代码确实是不太需要注释的,但这种情况目前我只感觉是存在于理想中,现实中,尤其是国内,注释还是很重要的,注释写的清楚,能为阅读你代码的人提供很大的帮助,尤其是无法保证代码作者和阅读者英文水平不对等的情况下,中文注释显得尤为重要。千万弄明白注释与代码的关系:是画龙点睛、不是越俎代庖更不是画蛇添足!1.不要花过多的时间维护原创 2016-08-16 14:59:22 · 741 阅读 · 0 评论 -
整洁代码----代码格式
代码格式就像写作时的文章格式一样,好得格式排版(这个词不是很准确,但很能表达出来我的意思),会让阅读者更加容易理解代码的层次。 目前绝大多数IDE 都会自动格式化代码,善用这些功能。1. 垂直代码的格式1.1 代码的行数大多数优秀代码的行数在200--500之间,参考(junit、tomcat、fitnesse、tam),数据作为参考,但绝对有价值。 1.2 善用空行相关信息放在一起,通过空行与原创 2016-08-16 16:46:56 · 454 阅读 · 0 评论 -
整洁代码----设计好错误处理
1.先写Try-Catch-Finally在写方法时优先写好Try-Catch-Finally 2. 尽量使用不可控异常可控异常解决方式:使用throw 向上抛出异常; 不可控异常解决方式:使用 try - catch 解决; 如果过多的使用throw 抛出异常,可能会对将来埋下隐患,如果修改代码则可能会涉及到修改多层代码链,所以在可能的情况下,尽量使用不可控异常来解决问题。 3. 给出异常发生的详原创 2016-08-16 18:37:54 · 386 阅读 · 0 评论 -
整洁代码----整洁的测试代码
1. 保持测试代码的整洁随着敏捷开发、TDD(要求在编写生产代码前先编写单元测试)越来越得到人们的认可,测试类、测试组越来越多,当测试类足够多时,如果不重视测试代码的整洁,将会像正式代码所面临的问题一样,乱成一团,最终被人丢弃。所以:测试代码和生产代码一样重要,应该像生产代码一样保持整洁。 2. 整洁的测试代码应遵守以下五条规则2.1 快速测试应该够快。测试应该能快速运行。测试运行缓慢,你就不会想要原创 2016-08-17 10:30:33 · 715 阅读 · 0 评论 -
整洁代码-----有意义的命名
注:本系列主要来自日常书籍阅读 向资深工程师请教 个人理解 如要转载请标明来源。 函数、类、参数等一切需要自己命名的地方。 以下方法,会对软件开发团队协作开发有重要作用,遭乱的名称,只会扯你的后腿。 见名知意 不要怕名称长,但一定要让它一看就知道它是做什么的 避免误导 相似含义的名称之间区别要明显尽量不用数字0和大写字母O,原创 2016-08-08 15:41:37 · 761 阅读 · 0 评论 -
整洁代码--写好方法(函数)
1.尽量短小在不影响功能的情况下尽可能的把方法写的小一些,尽量不要出现成千上万行的方法。 2.一个方法只做好一件事不要让一个方法做过多的事情,会让初看代码的人很迷茫,一个好的方法要让读者大概看一遍就知道这个方法是要做什么,而不是茫茫多的功能。 3.方法的分层现在绝大部分主流语言会分为web层,server层,和dao层,一个好的方法首先要确定目前的类是写在哪个层,在哪个层就用哪个层的代码不要越层使用原创 2016-08-12 16:29:00 · 557 阅读 · 3 评论