7.1. 通用命名规则

总述

函数命名, 变量命名, 文件命名要有描述性; 少用缩写.

说明

尽可能使用描述性的命名, 别心疼空间, 毕竟相比之下让代码易于新读者理解更重要. 不要用只有项目开发者能理解的缩写, 也不要通过砍掉几个字母来缩写单词.

  1. int price_count_reader;    // 无缩写
  2. int num_errors;            // "num" 是一个常见的写法
  3. int num_dns_connections;   // 人人都知道 "DNS" 是什么
  1. int n;                     // 毫无意义.
  2. int nerr;                  // 含糊不清的缩写.
  3. int n_comp_conns;          // 含糊不清的缩写.
  4. int wgc_connections;       // 只有贵团队知道是什么意思.
  5. int pc_reader;             // "pc" 有太多可能的解释了.
  6. int cstmr_id;              // 删减了若干字母.

注意, 一些特定的广为人知的缩写是允许的, 例如用 i 表示迭代变量和用 T 表示模板参数.

模板参数的命名应当遵循对应的分类: 类型模板参数应当遵循 类型命名 的规则, 而非类型模板应当遵循 变量命名 的规则.