代码注释风格

文件开头：

/**@file main.c
* @brief 项目主函数文件
* @details 主要包含协议应用栈程序框架，main函数入口
* @author wanghuan any question please send mail to 371463817@qq.com
* @date 2018-8-17
* @version V1.0
* @copyright Copyright (c) 2018-2020 江苏亨通光网科技有限公司
**********************************************************************************
* @attention
* 硬件平台:nRF52832_QFAA \n
* SDK版本：nRF5_SDK_15.0.0
* @par 修改日志:
* <table>
* <tr><th>Date <th>Version <th>Author <th>Description
* <tr><td>2018/08/17 <td>1.0 <td>wanghuan <td>创建初始版本
* </table>
*
**********************************************************************************
*/

函数注释

/**@brief NB模组向云平台上报数据
* @param[in] handle NB模组驱动句柄
* @param[in] *data 上报数据指针
* @param[in] len 上报数据长度
* @param[in] rcc_enabled 上报时是否主动释放RCC链接
* @param[in] update_enabled 上报时是否更新注册(只适用于onenet)
* @param[in] report_fail_try_type 上报失败重新注册类型 \n
* @ref NB_REPFAIL_REG_TRY 出错立即重试 \n
* @ref NB_REPFAIL_REG_DELAY_TRY 出错延缓重试，在延迟期间如果正常则重新延缓，适用于高频率上报（上报失败重新注册超时15min） \n
* @ref NB_REPFAIL_REG_NO_TRY 出错不重试
* @return 函数执行结果
* - NB_NOTIFY_SUCCESS 上报成功
* - NB_NOTIFY_FAIL 上报失败
* - NB_IOT_REGIST_FAILED 注册失败返回
* - Others 其他错误
* @par 示例:
* @code
* 移动平台发送数据 AT+MIPLNOTIFY=0,122553,3308,0,5900,4,4,50,0,0
* 电信平台发送数据 AT+M2MCLISEND=000101
* @endcode
* @see :: ME3616_FxnTable
*/

标签：TRY,代码,param,注释,风格,2018,上报,ref,NB
来源： https://www.cnblogs.com/leowindy/p/15135799.html