C文件和函数注释示例

    本文地址:http://tongxinmao.com/Article/Detail/id/235

    /******************************************************************************
    
                      版权所有 (C), 2013-2014, 老虎工作室
    
     ******************************************************************************
      文 件 名   : stack_heap_thread_process_2.c
      版 本 号   : 初稿
      作    者   : TigerXiao
      生成日期   : 2014年6月25日
      最近修改   :
      功能描述   : 这里只是对这个文件的描述
      函数列表   :
                  CheckThreadExist
                  CheckThreadStatus
                  main
                  StringToUpper
                  thread_start
      修改历史   :
      1.日    期   : 2014年6月25日
        作    者   : TigerXiao
        修改内容   : 创建文件
    
    ******************************************************************************/



    /************************************************************
    Copyright (C), 1988-1999, Tech. Co., Ltd.
    FileName: test.cpp
    Author:
    Version :
    Date:
    Description: // 模块描述
    Version: // 版本信息
    Function List: // 主要函数及其功能
    1. -------
    History: // 历史修改记录
    <author> <time> <version > <desc>
    David 96/10/12 1.0 build this moudle
    ***********************************************************/

    DOXYGEN版:

    /**

    * @file filename

    * @brief This is a brief description.

    * @details This is the detail description.

    * @author author

    * @date date

    * @version A001

    * @par Copyright (c): 

    * XXX公司

    * @par History:         

    * version: author, date, desc\n

    */




    /*************************************************
    Function: // 函数名称
    Description: // 函数功能、性能等的描述
    Calls: // 被本函数调用的函数清单
    Called By: // 调用本函数的函数清单
    Table Accessed: // 被访问的表(此项仅对于牵扯到数据库操作的程序)
    Table Updated: // 被修改的表(此项仅对于牵扯到数据库操作的程序)
    Input: // 输入参数说明,包括每个参数的作
    // 用、取值说明及参数间关系。
    Output: // 对输出参数的说明。
    Return: // 函数返回值的说明
    Others: // 其它说明
    *************************************************/



    DOXYGEN版:

    /**

     * This is a brief description.

     * This is a detail description.

     * @param[in] inArgName input argument description.

     * @param[out] outArgName output argument description. 

     * @retval OK 成功

     * @retval ERROR 错误 

     * @par 标识符

     * 保留

     * @par 其它

     *

     * @par 修改日志

     * XXX于201X-XX-XX创建

     */




    上一篇:XPRINTER-58 USB蓝牙打印机USB描述符
    下一篇:产品开发