C语言编程规范X - GOOGLECODE.docxVIP

第1章文件组织1.1文件命名1.文件名最长不得超过16字节（不包括扩展名）；文件名和目录名只能使用小写字母、数字和下划线；2.文件名要遵照“模块名_功能名”的格式；1.2文件组织结构1.文件组织以模块为单位，一个模块一个独立的源代码和资源文件目录，一般结构如下：XXXXXX\ //XXXXXX模块的源代码目录 XXXXXX.mk //makefile for module include\ //private header files deirectory source\ //source files directory resource\ //resource files directory2.一个模块一般包含四种文件(1).工程文件（.mk）；(2).头文件（.h）；(3).C文件（.c）；(4).RC文件（.rc）。3.一个模块一般只有一个工程文件；4.一个模块的头文件一般分成两部分：(1).提供给其他模块调用的接口的公共头文件（xxx_pub.h），存放在\public\include目录下；(2).提供给本模块内部使用的私有头文件（xxx_xxx.h），存放在本模块对应的\include\目录系5..c文件一般按照功能模块进行划分，一个模块还可以拆分成多个子模块，由多个.c文件组成；6.由于利用c语言的文件编译链接的方式进行裁减，一个模块的多个可供裁减的部分不能写成一个c文件，而应该各自写成独立的.c文件，并且不能直接引用其他C文件内部的函数或全局变量。1.3文件格式1.任何一个文件都应该有如下的文件头部说明：/******************************************************************************Copyright (c) yyyy,Corparation Name Co.,Ltd. All rights reserved.******************************************************************************//** @file * @brief * Project Name: * br * Module Name: * br * * @author * @date 2008/08/16 * @version * @par * detailed description * * @par Modification History * -------------------------------------- br * Date Name Desciption br * -------------------------------------- br * YYYY/MM/DD * */2.任何一个函数都应该有如下的函数头部说明：/** * @brief * @author * @param [IN] * @exception * @return * @par * detailed description * * @remarks * @par Modification History * -------------------------------------- br * Date Name Desciption br * -------------------------------------- br * YYYY/MM/DD * */3.任何一个.c文件都应该包含如下形式的头部和尾部：/******************************************************************************Copyright (c) yyyy,Corparation Name Co.,Ltd. All rights reserved.******************************************************************************//** @file * @brief * Project Name: * br * Module Name: * br * * @author * @date 2008/08/16 * @version * @par * detailed description * * @par Modification History * -----------------