1 代码文件头说明注释格式

/**
**********************************************************************
 * @file        Wiredevice.h
 * @author      [作者名]
 * @version     [版本号]
 * @date        [编写或修改日期]
 * @brief       [文件任务简介]
 * @license     Copyright (c) 2020-2032, xxxx有限公司
**********************************************************************
 * @attention
 * 修改历史     版本号        Author       修改内容
 *--------------------------------------------------
 * 2023.08.04    v01        [作者名]       创建文件
 *--------------------------------------------------
 *
**********************************************************************
 */

2 函数说明注释格式

/**********************************************************************
 *  函数名：LCD_GetFrameBuffer
 *  功能描述：获得LCD的Framebuffer
 *  输入参数：无
 *  输出参数：pXres/pYres/pBpp - 用来保存分辨率、bpp
 *  返回值：Framebuffer首地址
 * -----------------------------------------------
 * 2023/08/31        V1.0     韦东山       创建
 ***********************************************************************/