第 2 章 通用的编程规范

目录

2.1. 编程规范之风格
2.1.1. 风格统一
2.2. 编程规范之注释
2.2.1. 添加注释的原则
2.2.2. 注释的语法
2.3. 编程规范之命名
2.3.1. 命名的原则
2.3.1.1. 见名知意
2.3.2. 命名方法
2.3.2.1. 驼峰(式)命名法
2.3.2.2. 匈牙利命名法
2.3.3. 命名规范中的一些细节
2.3.3.1. 常量大写
2.3.3.2. 根据情况给名字加前缀
2.4. 编程规范之设计原则
2.4.1. 高内聚,低耦合
2.4.2. 使用频率高的代码,尽量做成函数和类库
2.4.3. 嵌套层次不要太深
2.5. 不同语言自己的特定的编程规范
2.6. 不同公司或组织的编程规范
2.6.1. Google的编程规范
2.6.2. 华为的编程规范

此处介绍,不论是任何计算机语言,相对来说都,通用的,具有普适性的一些编程规范。

2.1. 编程规范之风格

2.1.1. 风格统一

整个项目遵守同一种风格。

包括但不限于:

  • 命名方法

    要么都是驼峰法命名,要么都是匈牙利命名法,不要两者混用。

  • 括号的位置

    花括号{}的位置,要么是同一行,要么是换行对齐,不要混用。

  • 缩进

    缩进是用空格还是TAB键

    如果用空格缩进,空格是用2个还是4个

  • 代码中合适的位置添加空格以便于增加代码可读性
    • 二元操作符的左右添加单个空格

      比如,加减乘除等操作,大于号小于号等等

    • 。。。
    • 。。。
    • 。。。
  • 代码中合适的地方要加上必要的括号

    即使是,语法上,可以不用加括号,但是为了程序的可读性,以及减少笔误带来的出错机会,也要加对应的括号