良好的代码规范与注释

良好的代码规范与注释

一个好的代码规范与注释不仅让你的代码清晰，也增加了代码的易用性与复用性。当你以后回头去修改和调用代码时，可以更方便快速的理解代码，保持这种习惯也是一种良好的职业素质提现，也可以延长你的编码寿命。

代码规范

代码规范是指写代码是一种特点的风格，基本为变量命名，函数命名，宏命名，空格，大小括号等。

命名

一个变量命名需要清洗的表示变量的类型与意义，命名在这里我推荐用驼峰命名配合匈牙利命名。
函数、类等命名：
void GetValue();
class Food;
变量命名：
前置属性
全局变量 g_
常量 c_
成员变量 m_
静态变量 s_
变量类型
指针 p
函数 fn
无效 v
句柄 h
长整型 l
布尔 b
浮点型 f
双字 dw
字符串 sz
短整型 n
双精度浮点 d
计数 c（通常用cnt）
字符 ch（通常用c）
整型 i（通常用n）
字节 by 字 w
实型 r
无符号 u

空格

在函数之间需要空格，在变量与实现直接需要空格，在注释与其他之间需要空格。

大小括号

一般建议括号之间套层不要超过2层，多余的需要解耦。

注释

不要相信什么代码就是最好的注释，最好的注释就是没有注释的鬼话。注释就是为了告诉自己这是什么，防止以后看代码一头雾水。
注释需要几个基本的格式需要，来让注释有点逼格，虽然没什么作用，但是至少看了这个文件，这个函数是做什么的。
文件注释，表示这个源文件主要做什么功能的，谁写的，什么时间写的，属于XX公司的。
/ *

• 文件名：[文件名]

• 作者：〈版权〉

• 描述：〈描述〉

• 修改人：〈修改人〉

• 修改时间：YYYY-MM-DD

• 修改内容：〈修改内容〉
  */
  函数注释，就是说明下函数的功能，参数意义，返回值的意义等。
  // =========================================================
  // 函数原型：
  // 函数功能：
  // 参数说明：
  //
  //
  // 注意事项：
  // 函数返回：
  // =========================================================
  功能注释，大部分就是函数内对某个关键变量与算法进行说明，或奇葩的想法。
  //功能：