[郑重声明]木草山人编码的习惯

写代码如同写文章，每人风格不同。

在此特别说明山人的编码风格及习惯，免得与他人混到一起了。算是防伪吧。

 

1、代码段落及空行

一般地，在变量声明(定义)与语句之间都会留一空行；在各个关联不十分紧密部分也留一空行；每个函数之间留一空行；包含的头文件与代码之间留一空行；函数最后返回语句(如果有的话)与上面的代码之间留一空行(一般都会有的，除非忘记了)。

 

2、每个表操作性函数都会作出错处理，经典，比如打开文件、分配内存。

 

3、习惯地，表操作性质函数返回0表示操作成功，返回非零负数表示操作失败——经典地，该非零负数为-1，多种返回状态者除外。

 

4、任务完成或操作成功，习惯打印一行诸如“Job done!”、“Well done!”、“Mission complete!”之类的话。

 

5、不会在同一行上声明多个变量。

 

6、绝对区分调试信息和打印信息。

 

7、调试信息、打印信息及出错提示信息多数使用do{}wile(0)语句。

 

8、只包含必要的头文件，不会将没有用到的头文件胡乱包含进来。一般地，会在头文件后面标注出代码使用该头文件的部分函数。

——经典地，如清空结构体的函数bzero，在<strings.h>头文件中。

 

9、一般地，编译使用-Wall选项，尽量做到无警告信息，当然，程序bug除外。

 

10、一般非测试性程序区分头文件与实现文件。排版、编写遵循主流约定。

 

11、通常情况下，程序都是经过valgrind检测的，当然，这是在特定环境下，而且，程序的确存在内存泄漏而自己无能力解决的，会特别注明的。但这不说明所有程序都是如此测试。

 

12、一般在源代码文件开头处注明测试环境、结果及注意事项，当然，十分简单的除外。

 

 

                                                                                                                                          木草山人

                                                                                                                                 迟思堂工作室第一分队队长