函数命名
-
动宾短语
. good:jumpPage、openCarInfoDialog
. bad:go、nextPage、show、open、login
-
ajax 方法以 get、post 开头,以 data 结尾
. good:getListData、postFormData
. bad:takeData、confirmData、getList、postForm
-
事件方法以 on 开头
. onTypeChange、onUsernameInput、onCancelBtnIsClicked、onSaveBtnIsClicked
-
驼峰命名
. good: getListData
. bad: get_list_data、getlistData
-
尽量使用常用单词开头
. set、get、open、close、jump
-
变量类型为布尔值表达加上is,has,can,should这样的词会更明确
. isOpenDaliog、isShowAudioPlayer
-
使用更专业的词,比如不用get而使用fetch或者download
代码书写
- 函数的参数应该少。
- 最理想的函数参数的数量是零个,其次是一,再次是二,应尽量避免三。有足够的理由才能用上三个以上的参数。
如果函数看来需要两个,三个或者三个以上参数,就说明其中一些参数应该封装为类了. - 函数应该做一件事。做好这件事。只做这一件事。要判断函数是否不止做了一件事,还有一个方法,就是看是否能再拆出一个函数
- 标示参数,布尔值参数宣告函数做了不止一件事,应该消灭掉,即函数只做一件事
网友评论