关于代码规范

还有一些个人感想

Posted by Matrixtang on November 8, 2018

关于代码规范

这几天做协会的题目,题目可以写完,但是代码不是太规范。以下我自己的一些思考。

谷歌代码规范

image

谷歌的C++的规范

这个就是在网上找的代码规范了,当然,我自己也有自己的理解。

关于变量命名

命名约定

  1. 总体规则:不要随意缩写,除函数名可适当为动词外,其他命名尽量使用清晰易懂的名词;

  2. 宏、枚举等使用全部大写+下划线;

  3. 变量(含类、结构体成员变量)、文件、命名空间、存取函数等使用全部小写+下划线

eg int_num_count,全局变量以g_开头;

  1. 普通函数、类型(含类与结构体、枚举类型)等使用大小写混合,不含下划线; // 注释是我这种 前面一个空格 注释 后面两个空格

  2. 常量用k加大小写字母命名,不加下划线

eg .kDayInYear

使用这套命名约定,可以使代码具有一定程度的“自注释”功能,方便他人阅读,也方便自己以后修改。

关于格式

  1. 条件语句 过多时 用&&来分割下一行。condition 左右各一个空格
if( (condition_1) && (condition_2) || condition_3_emmmmmmm_exp_2) &&
 (condition_4))

2.尽量不使用非ASCII字符,如果使用的话,参考 UTF-8 格式(尤其是 UNIX/Linux 下,Windows 下可以考虑宽字符),尽量不将字符串常量耦合到代码中,比如独立出资源文件,返不仅仅是风格问题了;

  1. 赋值时尽量用 =
  2. 在return 后面无需加括号
  3. 水平/垂直留白不要滥用,怎么易读怎么来。

# 编程规范的思考

编程第一点 一定可以解决所提出的问题。之后才能来讨论代码的美的问题。

编程语言本身是一种语言,是一种和计算机交流的语言。只有懂得它们,才能有和计算机对话的机会。才能真正的运用计算机。你只有按照它们的语法规范来,它们才能真正理解你的意思。

《黑客与画家》这本书上曾经将程序员和画家类比了一下,作者将编程描述成和绘画一样具有艺术的活动。在这个意义上,代码更像是诗,它的美不仅仅体现在解决问题的方法上,更在你的编写上。因此,代码规范,不仅仅只是实用主义的,它更是美学上的。

只有将编程看作是一项艺术,而不是技术的时候,才能写出真正令人叹为观止的代码吧。

作者的邮箱 matrixkook@outlook.com