Code Style

Code Style

• 关于空格
  • 所有代码使用4个空格缩进
  • 运算符后使用一个空格
  • "," 和for循环语句中的";" 后面跟上一个空格
  • 条件、分支保留字，如 if for while else switch 后留出一个空格
  • "[]", "."和"->" 前后不留空格
• 用空行把大块代码分成逻辑上的“段落
• 关于括号
  • 大括号另起一行
  • 即便只有一行代码也加大括号
• C 指针中的指针符靠近类型名，如写成int* p，而不写成int *p
• 关于标点
  • 中文表述，使用中文全角的标点符号，如：（）、。，？
  • 数学公式（包括文中混排的公式）和英文代码，使用英文半角的标点符号，如：(),.?…
• 关于注释
  • 注释统一用中文
  • 尽量统一用"//"，一般不用"/*...*/"
• 关于命名
  • 类名为大写字母开头的单词组合
  • 函数名比较长，由多个单词组成的，每个单词的首字母大写，如int MaxSubArray()；函数名很短，由一个单词组成，首字母小写，比如int swap()
  • 变量名比较长，由多个单词组成的，首个单词的首字母小写，后面紧跟单词的首字母大写，如maxEnd；变量名很短，由一个单词组成，首字母小写，如left
  • 变量尽量使用全名，能够描述所要实现的功能，如 highestTemprature；对于已经公认了的写法才使用缩写，如 tmp mid prev next
  • 变量名能“望文生义”，如v1, v2不如area, height
  • 常量的命名都是大写字母的单词，之间用下划线隔开，比如MY_CONSTANT
  • il < 4384 和 inputLength < MAX_INPUT_LENGTH，后一种写法更好
• 一个函数只专注做一件事
• 时间复杂度小写表示，如O(nlogn)，而不写成O(N*logN)

转载自GitHub julycoding/The-Art-Of-Programming-By-July