代码命令规范书.docVIP

代码命令规范书

一、命名规范

1.变量命名

变量名应清晰表达其用途和含义，避免使用模糊或缩写不明确的名称。采用小驼峰命名法（lowerCamelCase），即第一个单词首字母小写，后续单词首字母大写。例如：

正确：userName、orderTotalAmount

错误：un（含义模糊）、OrderTotal（大驼峰不符合变量命名习惯）、user_name（下划线命名适用于Python等部分语言，但在Java、JavaScript等主流语言中不推荐）

对于布尔类型变量，应使用具有判断性的词汇开头，如is、has、can等，增强可读性。例如：

正确：isLoggedIn、hasPermission

错误：loginStatus（无法直接判断布尔值含义）

2.函数/方法命名

函数名采用小驼峰命名法，以动词或动词短语开头，明确表达函数的功能。例如：

正确：calculateTotalPrice()、getUserInfo()、updateOrderStatus()

错误：totalPrice()（缺少动词，无法体现操作）、GetUserInfo（大驼峰不符合函数命名习惯）

参数命名同样遵循变量命名规范，且参数数量不宜过多。当参数超过3个时，应考虑使用对象或结构体进行封装，提高代码的整洁性和可维护性。例如：

//不推荐functioncreateUser(name,age,em