要求

  1. readme 文件对上交的实验内容文件或目录作适当的解释；

  2. 每个源程序文件中注释信息至少包含以下内容：

    • 版权信息。
    • 文件名称，标识符，摘要或模块功能说明。
    • 当前版本号，作者/修改者，完成日期。
    • 版本历史信息。 //以上部分写在文件头
    • 所有的宏定义，非局部变量都要加注释
    • 所有函数前有函数功能说明，输入输出接口信息，以及调用注意事项
    • 函数关键地方加注释。

示例

readme

实验内容：

目录结构：<文件夹>：<内容解释>

文件：<文件名>：<功能解释>

文件头

/****************************************************
 * @Copyright © 2021-2023 Lyuyk. All rights reserved.
 *
 * @FileName: Example.cpp
 * @Brief:
 * @Module Function: 
 *
 * @Current Version: 1.2
 * @Author: Lyuyk
 * @Modifier: Lyuyk
 * @Finished Date: 2023/3/3
 *
 * @Version History: 1.1 
 *                   1.2 current version
 *                 
 ****************************************************/

函数前

/**
 * @brief <function name> <function describe>
 * @param <value...>
 * @return <value...>
 * PS: 1.attention1
 *     2.attention2
 */