1-空格与空行
留白的艺术。
恰当地运用空格和空行。而是要多用空格分隔开变量与操作符,用空行分隔开代码块,保持适当的阅读节奏。
2-起个好名字
为变量、函数、类、项目等起一个好听易懂的名字。
- 变量、函数名和名字空间用 snake_case,全局变量加“g_”前缀;_
- 自定义类名用 CamelCase,成员函数用 snake_case,成员变量加“m”前缀;
- 宏和常量应当全大写,单词之间用下划线连接;
- 尽量不要用下划线作为变量的前缀或者后缀(比如 local、name),很难识别
3-用好注释
注释表面上的功能很简单,就是给代码配上额外的文字,起到注解、补充说明的作用。
总的来说,要写好注释,你要时刻“换位思考”,设身处地去想别人怎么看你的代码,这样的话,上面的那些细则也就不难实施了。
4-小结
在编码阶段,拥有一个良好的编程习惯和态度是非常重要的。
- 用好空格和空行,多留白,让写代码就像写诗一样;
- 给变量、函数、类起个好名字,你的代码就成功了一半;
- 给变量、函数、类再加上注释,让代码自带文档,就成了“人能够看懂的代码”。
5-课下作业
1-你用过哪些好的 code style,你最喜欢今天介绍的哪几条?
OpenResty® C 代码风格指南
http://openresty.org/cn/c-coding-style-guide.html
2-注释在代码里通常的作用是“说明文档”,但它还有另外一个重要的用法,你知道吗?