前言

为了实现更高的自我价值（这跟自我价值有啥关系了？），决定使用统一的文件组织结构进行今后代码的开发。 源文件中实现变量、函数的定义，并指定链接范围。 头文件中书写外部需要使用的全局变量、函数声明及数据类型和宏的定义。

参考文献

https://www.cnblogs.com/clover-toeic/p/3728026.html

C文件组织

/**************************************
 * Description     : .c文件的组织结构（注释）
 * Author          : Joker
 * Date            : 2021-04-06 17:42:56
 * LastEditors     : Joker
 * LastEditTime    : 2021-04-07 19:25:33
 * FilePath        : undefinedc:UsersAdministratorC文件组织结构.c
 **************************************/

/**************************************
 *              文件包含
 **************************************/
//文件包含也有一定的顺序规则，待完成
/**************************************
 *              调试开关
 **************************************/

/**************************************
 *              宏定义
 **************************************/
 
/**************************************
 *              外部变量声明（不建议）
 **************************************/

/**************************************
 *              外部函数声明（不建议）
 **************************************/

/**************************************
 *              全局变量定义
 **************************************/

/**************************************
 *              局部变量定义
 **************************************/

/**************************************
 *              函数声明
 **************************************/

/**************************************
 *              函数定义
 **************************************/

函数注释

/**************************************
 * description : 
 * param        {uint8} AAAAA   : ？？？？
 * param        {uint8} TTTTT   : ？？？？
 * return       {void}
 **************************************/
void SSSSS(uint8 AAAAA,uint32 TTTTT)

H文件组织

/**************************************
 * Description     : .h文件的组织结构（注释）
 * Author          : Joker
 * Date            : 2021-04-06 17:42:56
 * LastEditors     : Joker
 * LastEditTime    : 2021-04-07 19:21:06
 * FilePath        : undefinedc:UsersAdministratorH文件组织结构.h
 **************************************/

/**************************************
 *              防止重复编译
 **************************************/

/**************************************
 *              文件包含
 **************************************/

/**************************************
 *              宏定义
 **************************************/

/**************************************
 *              类型重定义
 **************************************/

/**************************************
 *              变量的外部声明
 **************************************/

/**************************************
 *              函数的外部声明
 **************************************/

#endif

Doxgen格式注释

C文件

头文件