前言
最近感觉自己代码写得有点乱,就想着规范一下。写这个就是保存一下,以后方便拿来用。
头文件注释
/**
******************************************************************************
* @file demo.h
* @author LonelyPlutoW
* @version V1.0.0
* @date 2022-10-24
* @brief This file provides all the detail functions.
******************************************************************************
* @attention
*
* <h2><center>© Copyright (c) 2022 LonelyPlutoW.
* All rights reserved.</center></h2>
* 注释统一用多行注释
******************************************************************************
*/
#ifndef __DEMO_H
#define __DEMO_H
#ifdef __cplusplus
extern "C" {
#endif
/* 本头文件依赖的其它头文件 ———————————————————————————————————————————————————————*/
/* 需要对外的类型 ———————————————————————————————————————————————————————————————*/
/* 需要对外的宏定义 —————————————————————————————————————————————————————————————*/
/* 需要对外的常量 ———————————————————————————————————————————————————————————————*/
/* 需要对外的变量 ———————————————————————————————————————————————————————————————*/
/* 需要对外的函数声明 ————————————————————————————————————————————————————————————*/
#ifdef __cplusplus
}
#endif
#endif /* __DEMO_H */
/**
* @}
*/
/***************(C) COPYRIGHT LonelyPlutoW *************END OF FILE********************/
源文件注释
/**
******************************************************************************
* @file demo.h
* @author LonelyPlutoW
* @version V1.0.0
* @date 2022-10-24
* @brief This file provides all the detail functions.
******************************************************************************
* @attention
* 注释请统一用多行注释
******************************************************************************
*/
/* 本文件的头文件 ——————————————————————————————————————————————————————————————*/
/* 仅放自己的头文件 */
#include "demo.h"
/* 本文件依赖的头文件 ———————————————————————————————————————————————————————————*/
/* 本文件自定义类型 -————————————————————————————————————————————————————————————*/
/* 本文件依赖的宏定义 ———————————————————————————————————————————————————————————*/
/* 本文件使用的常量 -————————————————————————————————————————————————————————————*/
/* 本文件使用的变量 -————————————————————————————————————————————————————————————*/
/* 本文件使用的函数声明 ——————————————————————————————————————————————————————————*/
/* 所有的函数实现 ——-————————————————————————————————————————————————————————————*/
/**
* @brief This is a function
* @param None
* @retval None
* @return None
* @note None
*/
/**
* @}
*/
/***************(C) COPYRIGHT LonelyPlutoW *************END OF FILE********************/
原文地址:http://www.cnblogs.com/LonelyPluto-W/p/16822518.html
1. 本站所有资源来源于用户上传和网络,如有侵权请邮件联系站长!
2. 分享目的仅供大家学习和交流,请务用于商业用途!
3. 如果你也有好源码或者教程,可以到用户中心发布,分享有积分奖励和额外收入!
4. 本站提供的源码、模板、插件等等其他资源,都不包含技术服务请大家谅解!
5. 如有链接无法下载、失效或广告,请联系管理员处理!
6. 本站资源售价只是赞助,收取费用仅维持本站的日常运营所需!
7. 如遇到加密压缩包,默认解压密码为"gltf",如遇到无法解压的请联系管理员!
8. 因为资源和程序源码均为可复制品,所以不支持任何理由的退款兑现,请斟酌后支付下载
声明:如果标题没有注明"已测试"或者"测试可用"等字样的资源源码均未经过站长测试.特别注意没有标注的源码不保证任何可用性