关于代码命名,良好的命名规范是提升代码可读性和可维护性的关键。以下是综合多个权威来源的命名规范及建议:
一、命名规范
驼峰命名法(CamelCase) - 类名:
采用全大写驼峰命名法(PascalCase),例如 `Student`、`Product`、`UserService`。
- 方法/变量名:使用小驼峰命名法(lowerCamelCase),例如 `calculateArea`、`getUserInfo`、`price`。
- 常量名:全大写,单词间用下划线分隔,例如 `MAX_USERS`、`PI`。
下划线命名法 - 适用于类名、方法名或变量名,例如 `user_name`、`calculate_area`,但需注意与Python的命名规范冲突。
全大写命名法
- 仅用于常量或枚举值,例如 `MAX_CONNECTIONS`、`RED`、`GREEN`。
特殊符号规范
- 避免使用下划线或美元符号开头/结尾(如 `$name`、`name_`)。
- 类名中需避免使用 `DO`、`BO` 等保留字(如 `UserDO`、`HtmlDTO`)。
二、命名原则
描述性
名称应清晰表达用途,例如 `userProfile` 明确表示用户资料,`calculateTotal` 直接说明功能。
避免模糊
用具体词汇替代单字母变量名(如 `a` 改为 `price`、`quantity`)。
一致性
全局保持命名风格统一,例如类名全大写,局部变量全小写。
简洁性
在保证可读性的前提下尽量简短,例如 `findAllUsers` 可简化为 `findAll`(需确保不会引起歧义)。
三、常见错误及改进
单字母变量名: `a = 100` 改为 `price = 100`、`quantity = 200`。 保留字使用
枚举值:`RED`、`GREEN` 已符合规范,无需修改。
四、补充说明
类型名:通常与类名一致,采用全大写驼峰命名法。
方法命名:采用动宾短语,如 `calculateTotal`、`updateStatus`。
通过遵循以上规范,代码将更具可读性,便于团队协作与后期维护。