编程规范

发表于： 2024-12-19 分类于：笔记

字数： 1717 阅读：≈ 4分钟浏览：

笔者一直觉得自己的编程不够规范，突然想到准备简单学习一下这种规范

命名规范有助于提高代码的可读性和理解性。不同的命名风格有助于区分不同类型的变量、函数、类等。

变量和函数命名：
- 驼峰命名法（CamelCase）：大多数编程语言都使用驼峰命名法。变量名和函数名从小写字母开始，后续每个单词的首字母大写。
  - 示例：userName, getUserInfo()
- 下划线命名法（Snake_case）：在变量和函数名称中使用下划线来分隔单词。常见于 Python 等语言。
  - 示例：user_name, get_user_info()
- 大写命名法（UPPER_CASE）：常用于常量或枚举的命名，所有字母大写，单词之间用下划线分隔。
  - 示例：MAX_SIZE, PI_VALUE
类名命名：
- 帕斯卡命名法（PascalCase）：类名的每个单词首字母大写，没有下划线。
  - 示例：Person, EmployeeInfo
常量命名：
- 常量通常使用大写字母，并且单词之间用下划线分隔。
  - 示例：PI, MAX_LENGTH
命名注意事项：
- 避免使用缩写：除非非常常见（如 URL, HTML），否则避免使用缩写，保证代码的可读性。
- 有意义的名称：变量名和函数名应清晰表明其用途和功能。
有时候会给函数参数前加上一个下划线，以此来区分是函数参数还是外部全局变量

正确的缩进和格式化有助于提高代码的可读性，尤其是当代码变得复杂时。

缩进：
- 空格 vs 制表符（Tab）：通常推荐使用空格而不是制表符。一个常见的约定是每级缩进使用 2 或 4 个空格。
- 一致性：无论使用空格还是制表符，保持整个项目一致性至关重要。
行宽：
- 为了避免代码横向滚动，建议将每行代码的长度限制在 80 到 120 个字符之间。
空格的使用：
- 操作符前后加空格：操作符（如 =, +, -, *）前后应加空格，增加代码的可读性
```
int a = 5 + 3;  // 正确
int a=5+3;      // 错误
```
- 逗号后加空格：在列表、函数参数等中，逗号后应加一个空格。
```
let arr = [1, 2, 3];  // 正确`
```
- 换行：在表达式比较长时，可以在合适的位置拆分为多行，保证代码不会过长并保持可读性。

注释是帮助开发人员理解代码的重要工具。良好的注释可以减少维护代码的难度。

    /**
 * 计算两数之和
 * @param {number} a - 第一个数字
 * @param {number} b - 第二个数字
 * @returns {number} - 两数之和
 */
function add(a, b) {
    return a + b;
}