前端之如何编写出可维护的代码

113 阅读2分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第5天,点击查看活动详情

可维护代码必备的五大特点:容易理解、符合常识、容易适配、容易拓展、容易调试。

JavaScript为动态语言类型,正因为这门语言太过于灵活,所以编码规范对于前端显得尤为重要。

容易理解

可读性

  • 代码格式: 这个其实一般来说还好,因为现在编辑器大多可以格式化代码,如果公司有相关格式化代码的文件,只需要同一即可;

  • 函数方法:在定义函数方法后,尽可能的将每一个多参数的方法注明注释,其中注释包括传入的参数、类型、说明,如有返回值则明确返回值信息。至于为何要注明类型,因为JavaScript属于松散类型的语言,所以很容易忘记定义传入的参数类型。这一点在定义变量时也尤为适用。这不仅适用于简单的函数方法,同时也适用于大型代码块以及一些复杂的算法。

注意:当代码中有为某一特殊情况而处理的方法必须要注释清除明白,防止后人对其以为是“无用代码”而进行优化删除。

变量以及函数名

比较常见的变量名一般使用名词,而函数等方法名称则使用动词,而定义布尔值的变量则使用 is开头单词。

那么一些比较常见的前端规范则是变量以及方法名尽量使用驼峰命名法,首字母小写,而class类名则一般使用“羊肉串”格式。

以及现在越来越多的框架,其中框架也有相应的代码规范,那么需要去相应的框架了解其规范。

尽可能避免与关键字相同的方法名,需要做到见词达意。这样代码就会像是有生命,让人更容易理解。

容易拓展

只要程序中某一个部分对于另一个部分依赖的过于紧密,代码就会变得紧密耦合,难以拓展维护,当我们有了这个意识,就会时刻注意不会让代码产生紧密耦合,从而方便拓展维护。