JavaScript代码的可维护性 – 我的笔记本

JavaScript代码的可维护性

可维护的JS代码有如下一些特点

  • 容易理解:无须求助原始开发者,任何人一看代码就知道它是干什么的,以及它是怎么实现的
  • 符合常识:代码中的一切都显得顺理成章,无论操作有多么复杂
  • 容易适配:即使数据发生变化也不用完全重写
  • 容易扩展:代码架构经过认真设计,支持未来扩展核心功能
  • 容易调试:出问题时,代码可以给出明确的信息,通过它能直接定位问题

编码规范

可读性

写出可读性高的代码,首先需要注意的就是代码缩进。一般缩进4个空格,不要用制表符,因为制表符在不同的文本编辑器中,会显示不同。另外,需要养成对自己的代码进行注释的习惯,一般写注释的地方有:

  • 函数和方法:需要写清楚函数的用途、入参、出参,每个参数的含义
  • 大型代码块:完成单一任务的多行代码,需要给出注释
  • 复杂的算法:如果在代码中用到了比较复杂的算法,用注释表述清楚
  • 使用黑科技:这是解决浏览器之间的差异而写的代码,也需要用注释表述清楚

变量和函数命名

变量类型透明化

Related Posts

发表回复

您的电子邮箱地址不会被公开。 必填项已用 * 标注