Skip to content

Common Code Style

metal A-wing edited this page Apr 24, 2018 · 7 revisions

通用代码风格

作为一家搞硬件的公司,经常要在好多种编程语言下来回切换

本手册意在实现不同编程语言通用风格

文件编码

  • 使用 UTF-8 作为源文件编码
  • 使用 Unix-风格 换行符。(*BSD/Solaris/Linux/OSX 用户被为默认涵盖,Windows 用户必须特别小心.)

\n是换行,英文是LineFeed,ASCII码是0xA。 \r是回车,英文是Carriage Return ,ASCII码是0xD。 windows下enter是 \n\r,unix下是\n,mac下是\r

  • 如果你正在使用 Git 你可能会想要添加下面的配置设置来保护你的项目(避免)Windows 蔓延过来的换行符:

      $ git config --global core.autocrlf true
    
  • 空格通一使用 两个空格 的风格,一个制表符 == 两个空格 (python的PEP8是推荐用四个空格的,用两个空格也可以正常使用)

注释

无论是#还是// 都要加一个空格

    #bad
    # good
    //bad
    // good

注释上方请空一行

def ex():
    
    # 这是注释
    print("语句")

一段复杂的逻辑开始和结束时,请在开始和结尾各空一行

这是为了阅读方便

符号

括号前要有空格 bad:

if(a<b)

good:

if (a<b)

运算符两边要有空格

bad:

a=b
a&&b

good:

a = b
a && b

大括号统一写在右边: 当你写了好多好多代码的时候就会发现右边才是最佳实践

我以前大括号是另起一行的,后来发现不换行才是最佳操作 例:

Class Code {
}

Func

这个问题有点严重(可能会引发圣战) 因为在ruby python里

def some_method(some_arr)

在Java JavaScript里

def someMethod(some_arr)

待定中。。。。。

Class

通用使用上驼峰命名法

Class CommonCodeStyle

关于;

能不写尽量不写,新时代编程语言不应该有;

参考资料