个人 Golang 编程规范
单词缩写
| 单词 | 缩写 | 出处 |
|---|---|---|
| expression | expr | subPathExpr https://kubernetes.io/docs/concepts/storage/volumes/#using-subpath-with-expanded-environment-variables |
| function | fn | GetTsdbQueryEndpointFn |
| transaction | tx | |
| connection | conn | max_idle_conn |
函数命名
| 函数 | 说明 | 出处 |
|---|---|---|
| valueAsString | 以 string 类型打印配置文件中指定键值对的值 func valueAsString(section *ini.Section, keyName string, defaultValue string) (value string, err error) |
Grafana |
| RegisterXXX | 注册... | Grafana：RegisterNamedMiddleware |
| buildXXX | 构造，并返回 XXX | buildConnectionString |
变量、结构体、包命名
| 变量、结构体 | 说明 | 出处 |
|---|---|---|
| inProcXXX | 指运行在同一进程中 | Grafana: type InProcBus struct |
| inTransaction | 在同一事务内 | Grafaba |
| registry | 可以声明为 map，表示需要注册的，有唯一表示 ID 的 | Grafana：var registry map[string]GetTsdbQueryEndpointFn |
| namedXXX | 具名的... | Grafana：namedMiddleware |
| Dialect | 可作接口名，比如作为各种 db 的通用接口。NewMysqlDialect、NewSqlite3Dialect、NewPostgresDialect | Grafana：type Dialect interface |
| BaseXXX | 比如 BaseDialect 结构体，是实现了 Dialect 接口的类但又不是具体实现，是各具体实现的基类 | Grafana |
