博客园  :: 首页  :: 新随笔  :: 联系 :: 订阅 订阅  :: 管理

我的代码规范

Posted on 2020-09-16 22:54  KGday  阅读(50)  评论(0编辑  收藏

我的代码规范

1 缩进

  • 1.1 采用制表符缩进。

2 变量命名

  • 2.1 规则:命名尽量使用英文单词,力求简单清楚,避免使用引起误解的词汇和模糊的缩写,使人产生误解。

  • 2.2 规则:命名规范必须与所使用的系统风格保持一致,并在同一项目中统一。

  • 2.3 建议:用有意义的单词来定义标识符。

    说明:

    尽量不要使用 0、1 等数字 + 字母(单词)来表示不同的变量名,用有意义的单词把每一个变量都描述出来可以更加易于理解。
    
  • 2.4 建议:避免使用看上去相似的名称。

    说明:

     如“1”、“l”、和“I”看上去非常相似。
    

3 每行最多字符数

  • 3.1 每行最多 150 个字符。

4 函数最大行数

  • 4.1 一个函数最多为 300 行。

5 函数、类命名

  • 5.1 规则:函数名以大写字母开头,采用谓-宾结构(动-名)。

  • 5.2 规则:类命名须分别以 C 开头,其他一部分遵从一般变量命名规范。

6 常量

  • 6.1 尽量用英语名词表示常量,多个名词组合时用 _ 连接。

7 空行规则

  • 7.1 函数之间空一行。

  • 7.2 类之间空三行。

8 注释规则

  • 8.1 必要或易混淆的语句后添加注释。

9 操作符前后空格

  • 9.1 操作符前后都有一个空格。

10 其他规则

  • 10.1 在存在多个全局变量时,单独创建全局变量文件并import入主文件。