添加基本的代码规范

This commit is contained in:
nonstriater
2015-11-30 10:58:22 +08:00
parent b2aaaafefa
commit 4636cb94f3
+4 -10
View File
@@ -193,16 +193,13 @@ http://ac.jobdu.com/index.php 九度OJ
## C语言代码规范
这里面的代码均使用C语言完成,代码规范主要有:
这里面的算法代码均使用C语言完成,养成良好的代码规范习惯,不但可以写出优质的代码,也可以更快的阅读其他优秀开源代码。代码规范主要有:
### 符号命名
**变量名**
**局部变量** 尽量短,能表达清楚意思即可,能简写就简写,比如"err" 表示 "error"; "fd" 表示文件描述符 ,循环变量可以使用i,j,k ;结构体成员变量不需要"m_"前缀;全局变量"g_"开头
**常量名/宏定义** 全大写,单词之间"_"分割,如 "MAX_NUMBER_OF_SLAB_CLASSES" ;
对于options 宏定义,适当使用前缀 ,比如:
**常量名/宏定义** 全大写,单词之间"_"分割,如 "MAX_NUMBER_OF_SLAB_CLASSES" ;对于options 宏定义,适当使用前缀 ,比如:
```
/* Client classes for client limits, currently used only for
* the max-client-output-buffer limit implementation. */
@@ -231,7 +228,7 @@ enum conn_states {
};
```
**函数命名 ** 全小写,单词之间"_"分割。如"split_cmdline_strerror()"
**函数命名** 全小写,单词之间"_"分割。如"split_cmdline_strerror()"
### 注释
@@ -242,10 +239,7 @@ enum conn_states {
### 其他
合理使用static,const 等关键字,能提升程序的安全性,也能避免函数命名冲突
合理使用数据类型:rel_time_t,uint8_t,uint32_t,uint64_t,size_t
养成良好的代码规范习惯,不但可以写出优质的代码,也可以更快的阅读其他优秀开源代码。
合理使用数据类型:rel_time_t,uint8_t,uint32_t,uint64_t,size_t,off_t
## 联系