代码编写规则

本小节制定一些编写代码时使用的规则,以便大家达成共识,沟通顺畅。

为了增强代码的可读性,方便萌新们之间相互交流代码,我们有必要先约定一些规则:

  • 使用匈牙利命名法
  • 保持函数名称简短

匈牙利命名法

萌新们在编写代码时,通常喜欢简单地使用 i、j、k 来命名,可能不是太妥当,别人理解的时候,脑袋里面要运行着一个很深的堆栈。理解和遵循一定的变量命名规范,使得程序代码具有“自明”特性,编写程序就可以减少注释的工作,从而可以避免混淆。

匈牙利命名法(Hungarian notation)是计算机程序设计中的一种变量命名规则,由1972年至1981年在施乐帕洛阿尔托研究中心工作的程序员查尔斯·西蒙尼(Charles Simonyi)发明。此人后来成了微软的总设计师。

匈牙利命名法的基本原则是:

变量名 = 属性 + 类型 + 对象描述

其中每一对象的名称都要求有明确含义,可以取对象名字全称或名字的一部分。要基于容易记忆容易理解的原则。

比如,

g_fGyroscopeAngleSpeed

其中,g_ 表示表示全局变量,没有该前缀是局部变量。全局变量在头文件中进行定义,在程序初始化函数中都进行初始化。小写字母 f 代表变量类型float,而 GyroscopeAngleSpeed 为变量名称,表示变量的含义——陀螺仪测量的角速度。可以看出,匈牙利命名法非常便于记忆,而且使变量名非常清晰易懂,增强了代码的可读性,方便各程序员之间相互交流代码。

变量属性:

  • 全局变量:g_
  • 常量:c_
  • 静态变量:s_
  • x 轴:x_
  • y 轴: y_
  • z 轴:z_

类型部分:

  • float:f
  • double float:df
  • int:i
  • unsigned int:i
  • short int:n
  • long int:l
  • char:c

描述部分:

  • 最大 Max
  • 最小 Min
  • 初始化 Init
  • 临时变量 T(或Temp)