文档介绍：Linux平台软件代码编写规范
（仅供内部使用）
日期：
日期： 日期：
文档作者：
说明书校对：
项目经理：
版权所有不得复制
版本修改记录
版本号
日期
修改人
修改内容
与对应“.c" 文件同名，即“”，以下简称为".h”文件。
“.h”文件的内容，一是定义本模块用到的相应的数据结构。 函数作声明，确保他人在调用该模块相应函数或功能时只需要包含对应模块的h”文件即 可。
3） 特殊情况：对于多个模块都需要使用的一些关键变量，比如说，定义显示语言的变 量、日志信息的定义等，为了方便后来的修改，
3 文件结构
. 1 “.c”、".cpp "文件
".c”、".cpp”文件主要分为文件描述，全局变量声明、本文件范围内的变量的声 明、函数的实现几个部分。
".c” 、".cpp”文件以文件描述开始，内容包含该文件的作者，主要功能，修改记 录等等，需要使用注释符分行显示，格式如下图所示：
/*****************************Fi]e Description****************************
Main Functions:
Author: shaoying yang
*
Modification
Record:
*
Version
name
content
*
. 2
LiMing
corect the error of caculating disk size
*
V2. 0. 0
Lili
add disk temprature and error detection function
*
add USB storage device discovery function
*
Note:
其它各部分的前面都要加上一段/********* XXXXXXX ********/作为开始头，其中，XXX
表示后面的代码的部分的内容，例如：global variables, local variables, functionso 示例如下：
^include <stdio. h>
#define m_error(terminal, format, args. ..) fprintf(terminal, format, ## args);
/************************ global variables*********************************/ struct usb_device usb_device_info;
“.h"头文件
".h”文件与“.c”文件的书写要求基本相同，包括文件描述、头文件包含、变量声明、 数据结构定义、宏定义、函数声明等等。
但是除此之外，为了避免头文件重复包含导致编译出错，要求，每个“.h”文件必须以 #ifndef XXXX开始，后面马上跟上ttdefine XXXX ,并且整个文件文件以ttendif结束， 其中XXXX定义为该文件名的大写后加“_H”，示例如下：
文件<disk_manager. h> 内容
ttifndef DISK_MANAGER_H
^define DISK_MANAGER_H
ttendif
关于函数声明部分应包含该模块全部函数，并将其区分为模块内部函数和模块接口函数 两类分开声明，并通过static和extern关键字显示加以区别。
4函数
1 函数书写规范
每个函数前面都必须有一段留给注释的空间，注释头结构如下图所示:
/**************************detect_usb_device()****************************
Function: detect usb_device
Input: address of usb device information
Output:
Return: >0: numbers of usb device that has been found. -1:fail
Note:
int detect_usb_device (struct usb_device * usb_device_info)
注释的内容包括：该函数的功能，输入参数的意义、函数返回不同值的不同含义解释、 该函数使用时需要注意的事项。
函数一般从第0列开始书写，函数体的大括号也从第0列写起，并独占一行，函数的具 体内容即函数体，使用制表符“TAB”键加以缩进，通常为8个占位符。该