C语言头文件编写的几个基本规则
时间:2010-12-20 来源:cplayer
1. 防重入开关,也就是常见的 #ifndef… #define… #endif
2. #include ,头文件里应该 include 所有该文件中所使用的其它接口头文件。这里有也有两层含义,一是说头文件应做到自包含,即使用头文件的用户不需要再为该头文件 include 其它头文件;二是从模块耦合内聚角度来说,头文件中本身不应该 include 太多其它头文件,一般就是通用数据类型定义, include 其它头文件意味着强耦合——引用了其它头文件中的类型定义,宏或是函数。
3. 接口声明及注释,包括函数,结构体等,但不应该出现全局变量,和 static 类型的接口,这些都应该是放置在 C 文件中。函数的注释中应该包括功能说明,参数使用方法,可能的返回值,及其它注意事项。结构体的注释中应该包括每个成员变量所表示的含义。我们也提倡自注释,即通过合理的命名达到见名知意的效果。
相关阅读 更多 +