程序员经常会犯的五个错误

上一篇 / 下一篇  2021-09-02 11:29:34

  错误1:没有文档
  所有项目的第一个错误就是:没有任何文档。
  没有文档,如何开始呢?你如何了解项目结构、软件体系结构,以及在哪里找到你想要修改、更新的文件,文档是项目成功的关键,无论开源与否,你都需要确保自己记录了如何使用项目、如何测试和部署项目。而且有一些很好的项目可以帮助你编写文档,比如docusaurus。
  错误2:注释
  即使你有文档,你仍然需要理解代码,即使你是为自己编写代码,你仍然可能不记得某个特定代码段在做什么,或者它是如何使用的,当然,你不需要为函数int addToNumbers(int v1, int v2)编写注释,但可能需要为函数computeQuotaForUser(int userId)添加一些注释,比如在代码不明显或在多个关键代码不明显在或在多个关键代码路径上使用时进行注释。
  错误3:不可读的代码
  你是否曾经花了好几个小时去阅读一段代码并理解它的作用(尤其是在没有注释的情况下),每个开发人员都有这样的时刻。所以,你要确保自己的代码是可读的,不仅要在不明显的代码上添加注释,此外,还应在整个代码库中采用一致的风格。比如变量如何命名(例如,喜欢timeRemainingSeconds而不是timeremremaining),编写可以直接在屏幕上显示完整的简短的代码单元(大概40行左右)。
  错误4:没有测试
  另一个错误也是最大的错误是永远不要进行任何单元或集成测试。当然,你手动测试了代码,可以确保它可以在你的机器上运行,但是不能保证你的同事将运行相同的测试,并且也不能保证代码在干净的环境中运行(例如CI/CD管道)。
  要确保代码能顺利运行,编写单元测试,并在CI/CD管道中的每个更改时都运行它们。
  错误5:尽量不要使用强类型
  许多语言(例如JavaScript或Python)都不使用强类型。他们通过引入相应类型来解决这些问题(作为额外层的一部分——就像TypeScript,作为可选模块的一部分——就像Python)。
  强类型会引起一些问题,一些开发人员仍在使用字符串和整数做相加,比如“1”+ 1等于2(它等于11)。
  这类问题通常很难找到,而要找到罪魁祸首就像大海捞针。要避免此类问题,一定要慎重使用强类型,并始终声明类型。

TAG: 程序员

 

评分:0

我来说两句

日历

« 2021-11-22  
 123456
78910111213
14151617181920
21222324252627
282930    

数据统计

  • 访问量: 35273
  • 日志数: 251
  • 建立时间: 2020-08-11
  • 更新时间: 2021-11-22

RSS订阅

Open Toolbar