编码风格指南
该存储库可作为我们编码标准的参考以及我们产品的介绍。 您可以阅读公共部分,或跳转到特定语言的页面。 如果您有任何此处未涵盖的问题,检查和总是一个好主意
目录
命名约定
注释
制表符还是空格?
仅使用空格,每个缩进级别2 个空格。 切勿混用制表符和空格。
:up_arrow: 回到顶部
最大线长
将所有行限制为最多 90 个字符。 超出限制是可以容忍的,但不赞成。 请尽量避免。
:up_arrow: 回到顶部
空行
用一个空行分隔顶级函数和类定义。
使用单个空行分隔类中的方法定义。
在提高可读性的情况下(例如,为了描述逻辑部分),在方法或函数的主体内使用单个空行。
:up_arrow: 回到顶部
尾随空格
不要留下尾随空格。 使用插件为您突出显示。
编码
UTF-8 是源文件编码。
:up_arrow: 回到顶部
注释
必要时使用注释来描述必须对指示的代码块采取的特定操作。
将注释写在注释所描述代码正上方的