个人代码规范分享

Posted 2021-03-26 馒头加梨子

概述

今天我无意中看到一篇写代码规范的博客，深受启发，于是决定总结一下自己写代码的规范，记录下来，供以后开发时参考，相信对其他人也有用。

参考资料：

个人代码规范分享

变量长度

变量名不要缩写，不限制变量长度。（因为编辑器有自动补全功能，写长了也没关系，重要的是表达的意思到位）

变量命名

1.变量单词连接符

尽量不要使用单词连接符(and)，使用驼峰式命名，比如：

btnSaveClick

2.布尔值变量

使用is开头，比如：

isEnable
isVisible

3.列表类变量

使用List结尾，比如：

foodList
documentList

4.字典变量

使用Dic结尾，比如：

openWithDic
exeDumpDic

5.循环体临时变量

使用item结尾，比如：

documentItem

6.数据变量

从网络请求回的数据，或者经过预处理的数据，都使用Data结尾，比如：

xAxisData
segmentsData

函数命名

1.操作类函数

一般使用动词 + 形容词/名词，比如：

save()
deleteHospital()
saveAllProducts()

2.获取数据类函数

使用get开头，比如：

getDocumentList()
getElementById()

3.从网络获取数据类函数

使用CURD开头，分别表示：create，update，read，delete。比如：

createUser()
updateRole()
readProject()
deleteIndustries()

4.事件响应类函数

使用handle开头，比如：

handleClick()
handleChange()

需要注意下面2点：

1. 其它函数不能以handle开头
2. 看实际情况，如果 button 只有一个，则直接用 handleClick 即可；如果有多个，则需要加上用途来区别，比如：handleCancelClick()，handleCloseClick()；有时甚至需要加多个单词来区别，比如：handleIsEnabledChange()

其它

1. 命名完之后，停一小会儿，反思这个命名别人能不能理解
2. 数据预处理方法的命名：preProcessData()