编写高质量代码思想为源

Posted Xiao梁的学习笔记

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了编写高质量代码思想为源相关的知识,希望对你有一定的参考价值。

这一部分主要说的是程序员思想上应该具有怎样的觉悟吧,主要有两方面:

  • 编码的风格和习惯;
  • 编码背后的想法;

两者其实互为表里。

编码的风格和习惯

这一部分主要是讲下作为软件工程师,合格的,应具有怎样的良好习惯和风格。

合理选择单元测试

结论:单元测试不是万能的。

单元测试必须测试的三种场景:正常场景,边界场景,异常场景。

但由于

  • 人员假设场景进行测试;
  • 代码整合错误的不可避免性;
  • 场景有些难以复现
    等原因,单元测试不能完全覆盖测试工作。

合理添加注释

结论:注释应与代码意图吻合且简洁明了。

合理的注释场景:

  • 法律版权信息;
  • 解释意图的注释
  //Attempt to prevent deadlocks - see DBCP - 272
  DriverManager.getDrivers();
  • 警示性注释(参考源码中的一些注释)
  • TODO注释
  //todo:finish this part after ...
  

相反的,请尽量减少不必要的注释,或者冗余的、过时的注释。

遵循一定的原则

请直接参考在下另一篇文章:面向对象的几个重要原则

编码背后的想法

其实就是一句话:看待自己的身份为工程师而不是码农

以上是关于编写高质量代码思想为源的主要内容,如果未能解决你的问题,请参考以下文章

《编程的原则:改善代码质量的101个方法》读书笔记

《编程的原则:改善代码质量的101个方法》读书笔记

每周一书-编写高质量代码:改善C程序代码的125个建议

编写高质量代码改善C#程序的157个建议——建议108:将类型标识为sealed

编写代码片段的更简洁的方法

编写灵活稳定高质量的前端代码的规范二(推荐收藏)