上周C让我看看编程的智慧,这是一篇很长却总结得很好的文章,明明看了很久进度条一直没什么反应2333,,,很多观点都是以java为例,我java学得不深,再加上那天眼睛很累,后面没认真看就过去了。没想到今天C抽空给我修改了我这两天的代码,还提了修改意见,要注意的很多小细节等,还问我到底有没有认真看文章?我突然意识到代码规范的重要性,这些都是在学校没学到的东西,或者说一般学生会忽略的问题,今天下班回来,翻出这篇文章,很仔细也很慢地看了一遍,没想到一看就是一个晚上,因为原文实在太长,我一边看一边写了笔记,便于随时翻阅。笔记的字数也有1300+,下次可以尝试用思维导图的方式来梳理,会更清晰。
反复推敲代码
提高编程最有效的办法是反反复复地修改和推敲代码
写优雅的代码
优雅代码的特征:
(1)、形状特征:像分类整齐、套在一起的盒子
(2)、逻辑特征:树状结构,像电流在导线上的分流或汇合
(另:if语句最好有两个分支)
写模块化的代码
函数定义:模块化方法,有明确的输入(参数)和输出(返回值)
如何达到模块化:
(1)、避免写太长的函数(不超过40行)
(2)、制造小的工具函数(提取常用代码简化逻辑)
(3)、每个函数只做一件简单的事情
a、出现共用的代码改写成多个逻辑清晰的函数
b、提取相同代码做成一个辅助函数
c、避免使用全局变量和类成员,尽量使用局部变量和参数
写可读的代码
真正优雅可读的代码,几乎不需要注释。
学会合理利用程序语言的强大和严谨来表达它到底在干什么。
要点:
(1)、使用有意义的函数和变量名字
(2)、局部变量应该尽量接近使用它的地方
(3)、局部变量名字应该简短(骆驼拼写法)
(4)、不要重用局部变量(减小局部变量的作用域)
(5)、把复杂的逻辑提取出去,做成"帮助函数”
(6)、把复杂的表达式提取出去,做成中间变量
(7)、在合理的地方换行(根据代码的逻辑)
写简单的代码
并不是语言提供什么,你就一定要把它用上的。你只需其中很小的一部分功能,就能 写出优秀的代码。
代码规范:
(1)、避免使用自增减表达式(安全的两种使用情况:1、for循环 2、单独一行,如i++)
(2)、永远不要省略花括号 (光学幻觉)
(3)、合理使用括号,不要盲目依赖于操作符优先级
(4)、避免使用continue和break
1、把continue的条件反向消除continue(正面描述)
2、把break的条件合并(反转)到for\while循环头部的终止条件里,
3、break替换成return
4、提取循环里复杂的部分,做成函数调用,去掉continue\break
写直观的代码
原则:选择更加直接、清晰的写法,即使看起来更长、更笨
写无懈可击的代码
嵌套的if语句省略了else,依靠语句的'控制流'来处理else的情况,很难正确分析和推理。
if语句使用两个分支,无懈可击地处理所有可能的情况,避免反复的“面条代码"
正确处理错误
通用思想:穷举所有的情况,不漏掉任何一个。
代码漏掉任何一种可能出现的情况,都可能产生意想不到的灾难性结果。
如果你把异常catch了,忽略掉,那么你就不知道foo其实失败了。这就像开车时看到路口写 着“前方施工,道路关闭”,还继续往前开。这当然迟早会出问题,因为你根本不知道自己在干什么。
catch异常的时候,你不应该使用Exception这么宽泛的类型,应该正好catch可能发生的异常A。
try{...}catch里面应该包含尽量少的代码。
正确处理null指针
null的类型本来应该是NULL,也就是null自己。
原则:
(1)、尽量不要产生null指针,尽量不要用null来出初始化变量,函数尽量不要返回null.
(2)、不要catch NullPointerException,在null可能出现的当时就检查它是否是null,然 后进行相应的处理。
(3)、不要把null放进”容器数据结构“里面
(4)、函数调用者:明确理解null所表示的意义,尽早检查和处理null返回值,减少传播
(5)、函数作者:明确声明不接受null参数,当参数是null时立即崩溃
(6)、使用@NotNull和@Nullable标记
(7)、使用Optional类型
防止过度工程
1、先把眼前的问题解决掉,解决好,再考虑将来的扩展问题。
2、先写出可用的代码,反复推敲,再考虑是否需要重用的问题。
3、先写出可用,简单,明显没有bug的代码,再考虑测试的问题。