Show
于 2022-05-03 23:02:01 首次发布 版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。 一、有意义的命名示例1示例2示例3示例4图一图二图三示例5示例6示例7示例8二、函数1.尽可能短小2.只做一件事如果对你写的某个方法的代码进行审查时 发现他做了多件事 这些事中的某些小事 在其它地方也会做,或者你觉得在将来会被其地方用到,那么这个时候就涉及到代码的重用性或者说是重复度问题,那么这个时候就需要把这些小事独立抽取成一个方法,同时这样做也恰好满足了上面第一点函数行数尽可能短的原则 3.分隔指令与询问三、注释1.别给糟糕的代码加注释2.注释紧贴其相关代码3. 尽量用代码来表达你的意图比如 如下将 几个判断放到函数中 函数名则告知其意图 , 尽量用函数或者变量名来替代注释 4.必须要写的注释5.TODO注释的管理6. 公共API尽可能编写javadoc7. 糟糕的一些注释案例拿注释当标记 直接注释代码 四、格式1.空行 与紧贴封包声明 与第一个导包语句空行 相关的变量定义紧贴 不相关则考虑空行 最后一个成员变量 与第一个方法之间空行 方法与方法之间空行 2.局部变量声明尽可能靠近它被使用的地方3.实体变量应该在类的顶部声明4.相关函数放一起参数之间的空格 赋值,运算符的左右空格 5.注意缩进对比下面两段代码 一些空行 一些缩进 能极大增强代码的可读性 6.符合编码标准的优秀代码示例7.循环时 不要用 ; 来代替 空的语句体五、对象与数据结构写代码时考虑其或许可能的多态性说人话 :参数如果能用接口那么不用具体实现类, 就是看以下两段代码 多态式添加一个shape接口类 area方法后续的维护会变得更简单甚至不用动 过程式代码多态式代码
六、思考错误处理1.尽量不返回null比如 我们如果在返回值为list类型,其值为空时 可以返回 Collections.emptyList() 而非null,来避免调用者没判断是否为null而直接使用返回list对象而产生的空指针问题 2.使用异常来提示由于 某参数传递为非法时带来的问题比如如下 七、类1.组织与排列2.内聚3.隔离修改啥意思呢,就是能依赖父类不依赖子类,能依赖接口不依赖实现 |