《如何写代码 —— 编程内功心法》读后感

Posted 2020-10-04 行者无疆

原文链接：https://www.bughui.com/2017/08/21/how-to-write-code/

核心：

• 命名  ——  有名，万物之始
• 注释 —— javaDoc，参考jdk注释，包括用途、参数、exception说明，方便调用，一目了然
• 异常处理 ——
  • 当函数无法完成其宣称的任务的时候抛出异常！
  • 宁愿终止程序也不要带错运行下去。
• 日志 —— 
  • 日志框架、分级输出
  • 输出有效信息。
  • 上下文信息
  • 不要输出敏感信息。
• 参数校验 —— 外部调用(前端 or API接口)

自省：

• 命名： 不够较真
• 注释： 不够规范，@param说明不仔细，@throws基本不写
• 异常： 设计待提高
• 日志： debug、info基本不写
• 参数校验：不够重视

感悟：

　　作者的技术比我强，强多少就不说了，对编程概念的认识、理解也非常有见地。但是，更值得赞赏、学习的是字里行间透出的换位思考和团队意识。

　　从调用者的角度看，如果项目代码中的各种方法都像jdk源码一样注释规范、一目了然，并且还全是中文版，这是怎样的舒爽和幸福。但是，就像文中提到的：程序员在工作中都很讨厌这四件事情：

1. 写注释
2. 写文档
3. 别人不写注释
4. 别人不写文档

        怎样才能实现呢？窃以为还是有希望的，毕竟相对于阅读别人的无注释代码的痛苦，给自己的代码写写简单的方法注释只能算是举手之劳了。如果组内的小伙伴都能这样做的话，团队的开发效率必然有显著提升。

　　 正如《How to Win Friends and Influence People》所说，提供别人想要的东西，别人才会给你想要的。以规范约束终究落于下乘，只有体会到规范注释的好处，才会更积极 的遵守。因此，从自己做起，写好注释并带动自己的队友才是更好的办法，即使最终差强人意，也是对自己的一种提升。