Naming

导言

变量和函数的命名一直是程序员最头疼的事，好的命名应该简洁且自注释，同时还要注意冲突、和相似命名的歧义。

本文将从以下几个方面展开：

1. 驼峰型 、下划线型
2. 命名示例

命名风格

C标准库和Linux内核多使用下划线型，但许多C++项目（如Google C++ Style Guide）使用驼峰型

• 驼峰型：
  • 优点：紧凑，适合较短的名称。
  • 缺点：对于长名称，可读性可能较差（例如：findLongestCoreAffinityRange）。
• 下划线型：
  • 优点：清晰易读，尤其是对于长名称。
  • 缺点：名称可能显得冗长。

个人与公司的选择

• 公司：
  • 函数名、Class： 大驼峰型，如 FindLongestCoreAffinityRange。
  • 变量：小驼峰型，如 currentStart。

命名示例

函数命名

1. 经典的动宾短语？

变量命名

1. 临时变量:
   1. 单字母变量：如 i, j, k 用于循环计数器；x, y, z 用于坐标或数学计算。
   2. 简短单词：如 sum, count, temp, ptr 等。
   3. 上下文相关：根据上下文选择有意义的名字，如 current, next, prev。
2. 私有变量: time_
3. 静态变量: 可以添加 s_ 或 static_ 前缀来表明其静态性。
   1. 驼峰型：sCurrentStart, staticMaxLength
   2. 下划线型：s_current_start, static_max_length
4. 全局变量: 通常添加前缀（如 g_）或模块前缀。
5. typedef : 添加 _t 后缀
6. #define : 使用 全大写字母，单词间用下划线分隔。
7. struct/class/函数 命名： 大驼峰(首字母大写的驼峰型)。

参考文献

评论