前几天被面试官吐槽代码写的实在不行
这几天从几个方面加强了一下,先是看了最严重的代码规范问题,
这方面看了《编写可维护的JavaScript》受益颇多
函数的注释
各种编程语言中函数的注释也是需要特别注意的,一般来说,目前我接触的编程语言的函数注释都采用了以下这种方法:
/**
* @name: FunName
* @param {type} 在这里描述参数段作用
* @return {type}
* @Date: 2020-05-07 17:17:41
* @LastEditors: royalKnight
*/
一般来说,纯手打这一大长串的注释是非常的令人头疼的,我在这里推荐一个VScode上的一款插件,安装后按Ctrl+Alt+T就可以一键写入注释格式
koroFileHeader插件
命名
变量
命名方法,一般有两种:驼峰式和横线分隔式
命名方式一定要统一,不然到后期维护一定是非常头疼的问题
驼峰式样式:
由小写开始,之后的单词都首字符大写:
var anotherVariable
函数
对于函数的命名,也有自己的一套方法:
在函数的最开始,加上一些约定俗成的动词:
动词 | 含义 |
---|---|
can | 函数会返回一个布尔值 |
has | 函数会返回一个布尔值 |
is | 函数会返回一个布尔值 |
get | 函数会返回一个非布尔值 |
set | 函数会用来保存一个值 |
例如:
isEnable();
setName();
getName();
常量
对于常量的命名,一般使用全部大写和下划线来分隔
var MAX_COUNT=10;
var URL;
类(构造函数)
类,构造函数一般使用大写字母开头
function Person();