注释规范

前言

最近感觉自己代码写得有点乱，就想着规范一下。写这个就是保存一下，以后方便拿来用。

头文件注释

/***************(C) COPYRIGHT LonelyPlutoW *************BEGIN OF FILE***************/   
/**
  ******************************************************************************
  * @file      demo.h
  * @author    LonelyPlutoW
  * @version   V1.0.0
  * @date      2022-10-24
  * @brief     This file provides all the detail functions.
  ******************************************************************************
  * @attention
  *
  * <h2><center>&copy; 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********************/

源文件注释

/***************(C) COPYRIGHT LonelyPlutoW *************BEGIN OF FILE***************/   
/**
  ******************************************************************************
  * @file      demo.c
  * @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********************/