做项目时文件管理的相关总结

来源:互联网 发布:中国网络墙 编辑:程序博客网 时间:2024/06/16 08:23

1一个.cpp文件和一个.h文件构成了一个库;,也即是一个模块,一般而言,一个项目是由一个main..cpp文件和若干个模块组成的;

2.同一个类型或者同一个功能的代码,用一个.cpp文件和.h文件保存。

3.(.h)头文件中不能有可执行代码,也不能有数据的定义,只能有宏,类型(typedef,struct,union),数据和函数的声明(这里的宏,类型,数据和函数都可以被其他文件所用,但是这里有一个注意点,如果只想被本模块使用,那么没有必要写在本文件的头文件里面,直接写在本文件的.cpp文件里面即可,就是下面的第四点)

4.头文件里面不能包含本地数据(即只让模块自己使用的数据或函数)。只有模块自己使用的函数,数据,不要用externt在头文件里面声明,只有模块自己使用的宏、常量、类型也不要在头文件里面声明,应该在对应的.cpp文件里面声明。

(不要包含那些只有在本模块才使用的头文件,这些头文件应该在.cpp文件中包含)

5.防止被重复包含,使用宏”#pragmaonce”防止一个头文件被重复包含。

6.文件名和实现模块的c文件相同,例如”abc.c”对应的头文件应该是”abc.h”

7.接口文件要有面向用户的充足的注释;(一般注释三行,代码一行这个比例)

8.接口文件发布后尽量避免修改,即使修改也要保证不影响用户程序。