編碼規(guī)范

2.1 文件頭申明

◎ 新增.c必須添加注釋，標(biāo)注公司名稱、文件功能說(shuō)明，創(chuàng)建日期、作者，后續(xù)修改說(shuō)明 范例如下：

/*********************************************************************     
* Copyright (c)  Hehe,Ltd. All rights reserved.
* Description:用于詳細(xì)說(shuō)明此程序文件完成的主要功能，
*             與其他模塊或函數(shù)的接口依賴等關(guān)系           
*
* History:修改歷史記錄列表，包括修改日期、修改者及修改內(nèi)容簡(jiǎn)述                    
* Date               Author                Modification:                                                                     
* 2023-11-25        embedded-system        create v1.0
*********************************************************************/

可配置Source Insight 自動(dòng)生成模板。

2.2 文件

◎ 所有.h頭文件必須采取阻止內(nèi)容被包含多于一次的機(jī)制

#ifndef __XXX__
#define __XXX__
#endif  /*__XXX__*/

◎ 頭文件對(duì)外接口，應(yīng)放置對(duì)外部的聲明，如對(duì)外提供的函數(shù)聲明、宏定義、類型定義等。
◎ 內(nèi)部使用的函數(shù)聲明不應(yīng)放在頭文件中。
◎ 內(nèi)部使用的宏、枚舉、結(jié)構(gòu)定義不應(yīng)放入頭文件中。
◎ 變量定義禁止在頭文件中，應(yīng)放在.c文件中。
◎ 模塊內(nèi)使用的全局變量，不應(yīng)通過(guò)在頭文件中聲明的方式直接暴露給外部。
◎ 頭文件中只包含接口的聲明，不含實(shí)現(xiàn)。
◎ 頭文件應(yīng)當(dāng)職責(zé)單一，頭文件過(guò)于復(fù)雜，依賴過(guò)于復(fù)雜是導(dǎo)致編譯時(shí)間過(guò)長(zhǎng)的主要原因。
◎ 每一個(gè).c文件應(yīng)有一個(gè)同名.h文件，用于聲明需要對(duì)外公開(kāi)的接口。
◎ 禁止頭文件循環(huán)依賴,禁止包含用不到的頭文件。
◎ 每個(gè).c源文件內(nèi)容片段按如下順序，文件注釋-包含頭文件-宏定義-數(shù)據(jù)結(jié)構(gòu)定義-變量定義-引用外部變量-引用外部函數(shù)-本地函數(shù)-全局函數(shù)。