语言样式指南

2022-09-25

写语句时遵循统一的样式，可以增加可读性，减少错误。

各语言样式指南摘要

SQL

不用复数，尽量使用更自然的集合术语。比如，用“staff”替代“~~employees~~”，或用“people”替代“~~individuals~~”
使用snake_case
统一的后缀，下列后缀有统一的意义，能保证 SQL 代码更容易理解。在合适的时候使用正确的后缀。
- _id —— 独一无二的标识符，如主键。
- _status —— 标志值或任何表示状态的值，比如publication_status。
- _total —— 总和或某些值的和。
- _num —— 表示该字段包含数值。
- _name —— 表示名字，例如 first_name。
- _seq —— 包含一系列值。
- _date —— 表示该列包含日期。
- _tally —— 计数值。
- _size —— 大小，如文件大小或服装大小。
- _addr —— 地址，有形的或无形的，如 ip_addr
关键字总是大写，每个关键字定义之后换行
出于在数据库引擎之间达到最大程度兼容的目的，下面是一些建议使用的列数据类型。
- Character types 字符型
  - CHAR（固定长度字符串）
  - CLOB
  - VARCHAR（可变长度字符串，只要不超过定义的最大长度，具体存储时按实际字符串长度存储）
- Numeric types 数值型
  - 精确数值类型
    - BIGINT
    - DECIMAL（ DECIMAL(M, D)，M 表示整数部分加小数部分的位数，D 表示小数部分位数）
    - DECFLOAT
    - INTEGER
    - NUMERIC
    - SMALLINT
  - 近似数值类型（存储符号（S）、尾数（M）和阶码（E））
    - DOUBLE PRECISION
    - FLOAT
    - REAL（默认是DOUBLLE，可以设置为FLOAT）
- Datetime types 日期时间类型
  - DATE
  - TIME
  - TIMESTAMP
- Binary types 二进制类型
  - BINARY
  - BLOB
  - VARBINARY
- Additional types 其他类型
  - Boolean
  - INTERVAL
  - XML
MySQL中推荐使用的数据类型
- 整数：INT。
- 小数：DECIMAL。
- 字符串：TEXT。(系统自动按照实际长度存储，不需要预先定义长度。不能当主键)
- 日期与时间：DATETIME。

C/CPP命名风格

取百家之长：

变量、函数名和名字空间用 snake_case，全局变量加“g_”前缀；
自定义类名用 CamelCase，成员函数用 snake_case，成员变量加“m_”前缀；
宏和常量应当全大写，单词之间用下划线连接；
尽量不要用下划线作为变量的前缀或者后缀（比如 _local、name_），很难识别。

示例如下：

#define  MAX_PATH_LEN  256             //常量，全大写

int g_sys_flag;                        // 全局变量，加g_前缀

namespace linux_sys {                // 名字空间，全小写
  void get_rlimit_core();               // 函数，全小写
}

class FilePath final                 // 类名，首字母大写
{
public:
  void set_path(const string& str);    // 函数，全小写
private:  
  string m_path;                      // 成员变量，m_前缀 
  int    m_level;                     // 成员变量，m_前缀
};

各语言样式指南摘要

SQL

C/CPP命名风格

参考链接