C语言文件名命名的规则
1、文件标识符分为两部分,即文件名前缀和后缀。文件名前缀的最前面要使用范围限定符——模块名(文件名)缩写。
2、采用小写字母命名文件,避免使用一些比较通俗的文件名,如:public.c 等。
C语言文件内容的一般规则
1、每个头文件和源文件的头部必须包含文件头部说明和修改记录。
源文件和头文件的头部说明必须包含的内容和次序如下:
/************************************************************************
* File Name : FN_FileName.c/ FN_FileName.h
* Copyright : 2003-2008 XXXX Corporation, All Rights Reserved.
* Module Name : Draw Engine/Display
*
* CPU : ARM7
* RTOS : Tron
*
* Create Date : 2008/10/01
* Author/Corporation : WhoAmI/your company name
**
Abstract Description : Place some description here.
**
-----------------------Revision History---------------------------------
* No Version Date Revised By Item Description
* 1 V0.95 08.05.18 WhoAmI abcdefghijklm WhatUDo
*
************************************************************************/
2、各个源文件必须有一个头文件说明,头文件各部分的书写顺序下:
其中Multi-Include-Prevent Section 是用来防止头文件被重复包含的。如下例:
#ifndef __FN_FILENAME_H
#define __FN_FILENAME_H
#endif
其中“FN_FILENAME”一般为本头文件名大写,这样可以有效避免重复,因为同一工程中不可能存在两个同名的头文件。
/************************************************************************
* File Name : FN_FileName.h
* Copyright : 2003-2008 XXXX Corporation, All Rights Reserved.
* Module Name : Draw Engine/Display
*
* CPU : ARM7
* RTOS : Tron
*
* Create Date : 2008/10/01
* Author/Corporation : WhoAmI/your company name
**
Abstract Description : Place some description here.
**
----------------------------------------Revision History---------------------------------
* No Version Date Revised By Item Description
* 1 V0.95 08.05.18 WhoAmI abcdefghijklm WhatUDo
*
************************************************************************/
/************************************************************************
* Multi-Include-Prevent Section
************************************************************************/
#ifndef __FN_FILENAME_H
#define __FN_FILENAME_H
/************************************************************************
* Debug switch Section
************************************************************************/
#define D_DISP_BASE
/************************************************************************
* Include File Section
************************************************************************/
#include "IncFile.h"
/************************************************************************
* Macro Define Section
************************************************************************/
#define MAX_TIMER_OUT (4)
/************************************************************************
* Struct Define Section
************************************************************************/
typedef struct CM_RadiationDose
{
unsigned char ucCtgID;
char cPatId_a[MAX_PATI_LEN];
}CM_RadiationDose_st, *CM_RadiationDose_pst;
/************************************************************************
* Prototype Declare Section
************************************************************************/
unsigned intMD_guiGetScanTimes(void);
…… #endif
3、源文件各部分的书写顺序如下:
/*************************************************************************
* File Name : FN_FileName.c
* Copyright : 2003-2008 XXXX Corporation, All Rights Reserved.
* Module Name : Draw Engine/Display
*
* CPU : ARM7
* RTOS : Tron
*
* Create Date : 2003/10/01
* Author/Corporation : WhoAmI/your company name
**
Abstract Description : Place some description here.
**
-----------------------Revision History---------------------------------
* No Version Date Revised By Item Description
* 1 V0.95 00.05.18 WhoAmI abcdefghijklm WhatUDo
*
************************************************************************/
/************************************************************************
* Debug switch Section
************************************************************************/
#define D_DISP_BASE
/************************************************************************
* Include File Section
************************************************************************/
#include "IncFile.h"
/************************************************************************
* Macro Define Section
************************************************************************/
#define MAX_TIMER_OUT (4)
/************************************************************************
* Struct Define Section
************************************************************************/
typedef struct CM_RadiationDose
{
unsigned char ucCtgID;
char cPatId_a[MAX_PATI_LEN];
}CM_RadiationDose_st, *pCM_RadiationDose_st;
/************************************************************************
* Prototype Declare Section
************************************************************************/
unsigned int MD_guiGetScanTimes(void);
/************************************************************************
* Global Variable Declare Section
************************************************************************/
extern unsigned int MD_guiHoldBreathStatus;
/************************************************************************
* File Static Variable Define Section
************************************************************************/
static unsigned int nuiNaviSysStatus;
/************************************************************************
* Function Define Section
************************************************************************/
4、需要对外公开的常量放在头文件中,不需要对外公开的常量放在定义文件的头部。
分享到:
相关推荐
PDF ISO 32000 PDF文档规范,版本PDF 1.7 英文版 PDF文档结构分析 PDF文档结构分析 PDF文档结构分析
读书笔记——MIDI文件结构简介
软件工程文档结构
3. 文档结构, 说明一些基本的对象类型是如何来表现PDF文档的成分的:页,字体,批注,和另外一些内容。4. 内容流.一个PDF文件内容流包含一系列的指令,描述页面的外观或其他图形实体的外观和文件内容。
windows程序的文件结构,系统介绍文件结构的文档 windows程序的文件结构,系统介绍文件结构的文档
PDF(Portable Document Format,便携式文档结构)是一种很有用的文件格式,其最大的特点是平台无关而且功能强大(支持文字/图象/表单/链接/音乐/视频等).做PDF的解析,首先要熟悉PDF文件的物理结构和逻辑结构。PDF文件...
这是word-doc文件结构pdf,英文版,对分析word-doc文件结构有用。由于word-doc文件结构比较复杂,其它文档将在以后陆续上载。
在Word2021中使用大纲视图和文档结构图.docx
JPG文件结构分析,对JPG图片文件的结构作较详细的讲解。
在WinForm中打开Word预览,并抓取文档结构,文档定位,文档操作。
EA文档结构图
经典好用的文档结构画图工具,以后画图方便!!
多文档结构,document/view结构是MFC的核心,掌握了此技术将对VC学习有很大帮助
PDF 文档结构 二进制 节点 解析器,可以打开pdf,查看pdf各个节点的情况
教您如何使用word文档结构图和目录 一、用大纲级别结合文档结构图快速定位 二、在大纲视图中设置大纲级别 ⒈重新组织文档 ⒉改变段落的大纲级别 三、用大纲级别自动生成目录
树形结构之文件结构 简单代码,如何打开文件时在界面以树形方式显示子目录和文件
内有说明文件,按说明文件配置后,即可一键打开和关闭文档结构图。 把Normal.dotm文件保存到如下位置即可使用文档结构图的快捷键(Ctrl+D),如果需要修改,可以直接选择:自定义-快捷键-viewdocumentmap C:\Users\...
JavaScript实现文档结构图! 值得下载看看!资源免费,大家分享!!
解析PE文件结构(开发语言为C++,开发工具为Qt...PE文件解析工具的开发文档由于对本人还有用处,最近两年内不能公开,有需要的可以私下里联系我QQ:1909631452(路痴),可以给你个人,但是也请不要在两年内公开。
word中的目录生成,格式与样式的便捷,生成规整文档结构图的技巧