问Doxygen @param方向参数[in]，[ out]，[in，out]示例输出EN2、减小batch-size 这个比较容易修改 ...
函数信息 @param 参数名 说明文字 --> 不建议使用这个 @param[in] 参数名 说明文字 --> 输入参数 @param[out] 参数名 说明文字 --> 输出参数 @param[in,out] 参数名 说明文字 --> 即输入又输出参数 @exception 用来说明异常类及抛出条件 @remark 表示评论,暴露给客户程序员的文档 @return 说明文字 --...
* @param[in] 输入参数 输入参数描述信息 * @param[out] 输出参数 输出参数描述信息 * @return 返回类型 * @retval 返回值 返回值意义描述信息 */ 3 使用教程 3.1 Doxygen Wizard Project 3.2 Doxygen Wizard Mode 3.3 Doxygen Wizard Output 3.4 Doxygen Wizard Diagrams 3.5 Doxygen Expert Project 3.6 Doxygen...
1) @param 参数名 说明文字 --> 不建议使用这个 @param[in] 参数名 说明文字 --> 输入参数 @param[out] 参数名 说明文字 --> 输出参数 @param[in,out] 参数名 说明文字 --> 即输入又输出参数 2) @arg 参数/返回值 说明文字 --> 以列表形式说明参数取值意义 注:也可以用 - 或 -# 来代替,建议...
1) @param 参数名 说明文字 –> 不建议使用这个 @param[in] 参数名 说明文字 –> 输入参数 @param[out] 参数名 说明文字 –> 输出参数 @param[in,out] 参数名 说明文字 –> 即输入又输出参数 2) @arg 参数/返回值 说明文字 –> 以列表形式说明参数取值意义 ...
@param[in] 输入参数1 @param[in] 输入参数2 @param[out] 输出参数1 @return 返回值解释一下 @warning 警告: 例如: 参数不能为空啊,内存要外部释放之类的费话 @note 注解 随便你了 @see 相当于是请参考xxoo函数之类的 */ 变量或者只有一行注解的东东,不超过一行的注释: ...
参数可指定in/out,例如@param[out] dest、@param[in,out] buffer D. 成员变量的注释,如果注释写在变量右边,则加“<”,例如//!< …… 更深层次的标记请查看C++ Doxygen帮助中的“Documenting the code”,Doxygen用法后面演示说明。
* @param[out] buffer 用于存放读取的文件内容* @param[in] len 需要读取的文件长度* @return 返回读取文件的长度* - -1 表示读取文件失败 * @pre \e file 变量必须使用 ::OpenFile 返回值* @pre \e buffer 不能为 NULL* @see ::OpenFile ::WriteFile ::CloseFile*/int ReadFile(int file, ...
* @param [in] param1 参数1说明 * @param [out] param2 参数2说明 * @return 返回值说明 */ int func(int param1, int param2); /* * 打开文件 \n * 文件打开成功后,必须使用 ::CloseFile 函数关闭。 * @param[in] file_name 文件名字符串 ...
Function* @see Box_The_Last_One* @see <http://website/>* @note Something to note.* @warning Warning.*/intdoxygen_theFirstFunction(intparam1,intparam2); 对于所有头文件的函数,都需要进行函数注释。 @param:标记变量 [in] [out]表示输入输出方向...