C语言的相关文件组织结构

Joker_H_

已于 2022-02-10 11:59:00 修改

阅读量734

点赞数 1

分类专栏： C程序猿的自我修养文章标签： c语言开发语言后端

于 2021-04-06 17:24:37 首次发布

本文链接：https://blog.csdn.net/Joker_H_/article/details/115465939

版权

C程序猿的自我修养专栏收录该内容

4 篇文章 1 订阅

订阅专栏

前言

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

参考文献

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:\Users\Administrator\C文件组织结构.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:\Users\Administrator\H文件组织结构.h
 **************************************/

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

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

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

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

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

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

#endif

Doxgen格式注释

C文件

/**
 * Copyright (c) 2014-2022 UIOT Group. All rights reserved.
 * 
 * @brief 文件描述
 * @file 文件名
 * @author 作者
 * @version 版本
 * @date 日期
 * 
 */

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

/**
 * *******************************
 *            调试开关
 * *******************************
 */

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

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

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

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

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

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

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

头文件

/**
 * Copyright (c) 2014-2022 UIOT Group. All rights reserved.
 * 
 * @brief 文件描述
 * @file 文件名
 * @author 作者
 * @version 版本
 * @date 日期
 * 
 */

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

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

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

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

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

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