# 编程规范

文件名、包名、模块名、局部变量名、函数&方法名：全小写+下划线式驼峰
类：首字母大写式驼峰。内部类可以使用额外的前导下划线
函数和方法的参数
- 类实例方法第一个参数使用self, 类方法第一个参数使用cls
- 如果一个函数的参数名称和保留的关键字冲突，通常使用一个后缀下划线好于使用缩写或奇怪的拼写
全局变量
- 对于from M import *导入语句，如果想阻止导入模块内的全局变量可以使用旧有的规范，在全局变量上加一个前导的下划线。
- 全大写+下划线式驼峰，应避免使用全局变量
变量
- 不论是类成员变量还是全局变量，均不使用 m 或 g 前缀。
- 私有类成员使用单一下划线前缀标识，多定义公开成员，少定义私有成员。
- 变量名不应带有类型信息，因为Python是动态类型语言，在解释的时候才确定类型
常量
- 所有字母大写，由下划线连接各个单词
异常
- 因为异常也是一个类，所以遵守类的命名规则。此外，如果异常实际上指代一个错误的话，应该使用Error做后缀
缩写命名应当尽量使用全拼写的单词，缩写的情况有如下两种：
- 常用的缩写，如XML、ID等，在命名时也应只大写首字母，如XmlParser。
- 命名中含有长单词，对某个单词进行缩写。这时应使用约定成俗的缩写方式。
```
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num
```

关于下划线

一个前导下划线：表示私有。
一个后缀下划线：避免关键字冲突。
以单下划线开头，是弱内部使用标识，from M import * 时，将不会导入该对象（python 一切皆对象）。
两个前导下划线：当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线：有特殊用途的对象或者属性，例如init或者file。绝对不要创造这样的名字，而只是使用它们。
以双下划线开头的变量名，主要用于类内部标识类私有，不能直接访问。
双下划线开头且双下划线截尾的命名方法尽量不要用，这是标识

# GNU风格版本规则

语义化版本 https://github.com/semver/semver (opens new window)

MAJOR.MINOR.PATCH即： 主版本号.次版本号.修正版本号
Major.Minor.Revision即： 主版本号.次版本号.修正版本号

Major 主版本号：表示当前APR的主版本号，它的变化通常意味着APR的巨大的变化，比如体系结构的重新设计、API的重新设计、重大的重构、重大的feature改动、重大的不兼容性的变化等等，而且这种变化通常会导致APR版本的向前不兼容。
Minor 次版本号：发布较大的新feature功能，或者较大的重构或者模块变化，或者出现不兼容性改动，会增加子版本号；子版本的发布会伴随着完整的change log，算是一个较大的版本发布，有仪式感
Revision/PATCH 修正版本号：往往是bug fix，或者增加较小的feature，较小的功能改进或者模块变化，在保证完整向后兼容的前提下，会增加修正版本号
当主版本号增加时，子版本号及修正版本号置0
当子版本号增加时，修正版本号置0

按照测试过程标识

Alpha版：预览版或内部测试版，一般不向外部发布，会有很多Bug。
Beta版：公测版。
RC版：Release Candidate候选版本。也叫做Gamma版本。

# Commit提交规范

bugfix/fix/fixed: 表示修复 bug
feature: 表示增加新功能
add: 表示增加类、文件、代码块等
delete/del: 表示删除类、文件、代码块等
update: 表示对代码块、功能的更新
refactor: 表示对代码块、功能重构（即不是新增功能，也不是修改bug的代码变动）
arch: 表示输出中间版本，用于测试等
release to v1.0.0: 表示打包输出的版本号
test：增加测试
chore：构建过程或辅助工具的变动

mod 修改
changed ( 完成的任务 )
rem:移除（Remove,移除功能）
feat：新功能（feature）
docs：文档（documentation）
style：格式（不影响代码运行的变动）

# switch

在Python中没有switch语法
JavaScript的switch语法跟Java一样
在Java中

如果default不是switch代码块中最后一个case，请记得用break;结束默认case。

switch ("A".toLowerCase()) {
case "a":
    System.out.println("a");
    // 注意：此处如果条件满足但没有添加break，则代码会继续执行，
    // 会无条件执行后面的语句，直到遇到break
    //break;
    // fall thorugh
case "b":
    System.out.println("b");
    break;
default:
    // 如果default写在最前面，会先执行，
    // 但是如果没有写break;还是会无条件执行后面的语句
    System.out.println("default");
    break;
}

在Go中

左花括号{必须与switch处于同一行；
条件表达式不限制为常量或者整数；
单个case中，可以出现多个结果选项，以,分割；
与C语言等规则相反，Go语言不需要用break来明确退出一个case；
只有在case中明确添加fallthrough关键字，才会继续执行紧跟的下一个case；
可以不设定switch之后的条件表达式，在此种情况下，整个switch结构与多个if...else...的逻辑作用等同。

switch strings.ToLower("A") {
case "a":
    fmt.Println("a")
case "b":
    fmt.Println("b")
default:
    fmt.Println("default")
}

← 硬件交互表达式和编码 →