文件结构-项目驱动——can-bus现场总线基础教程pdf版本

第七章 文件结构 一个工程是往往由多个文件组成。这些文件怎么管理、怎么命名都是非常重要的。下面 给出一些基本的方法，比较好的管理这些文件，避免错误的发生。 7.1，文件内容的一般规则 【规则7-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 * ************************************************************************/ 【规则7-2】各个源文件必须有一个头文件说明，头文件各部分的书写顺序下： 其中 Multi-Include-Prevent Section 是用来防止头文件被重复包含的。 如下例： #ifndef __FN_FILENAME_H #define __FN_FILENAME_H #endif 其中“FN_FILENAME”一般为本头文件名大写，这样可以有效避免重复，因为同一工程 中不可能存在两个同名的头文件。 No. Item 1 Header File Header Section 2 Multi-Include-Prevent Section 3 Debug Switch Section 4 Include File Section 5 Macro Define Section 6 Structure Define Section 7 Prototype Declare Section