23,121
社区成员
发帖
与我相关
我的任务
分享linux 下开源软件的注释 的小问题
/**
* write stuff:Objects
* this is a single event.
*
* @param writer
* @param event
* @param algtype
* @param ss_level
* @param eventindex
*
* @retval PTS_SUCCESS
* @retval PTS_INTERNAL_ERROR
*
*
*/
对于这个 ，是一个函数的注释 ，@param 是什么意思 。@retval 这个应该是返回值 。
* write stuff:Objects
* this is a single event.
*
* @param writer
* @param event
* @param algtype
* @param ss_level
* @param eventindex
*
* @retval PTS_SUCCESS
* @retval PTS_INTERNAL_ERROR
*
*
*/
对于这个 ，是一个函数的注释 ，@param 是什么意思 。@retval 这个应该是返回值 。
...全文
请发表友善的回复…
发表回复
fx397993401 2011-11-30
- 打赏
- 举报
恩 好的 谢谢了
李迟 2011-11-30
- 打赏
- 举报
@param，“参数”英文的前几个字母。
这个doxygen格式的注释，使用这个注释后，用doxygen工具就能生成访文档了，十分方便。很多开源项目都用它来生成文档。
下面是一个例子：
http://www.latelee.org/yetanothertest/camera-html-cn/main_8c.html
这个doxygen格式的注释，使用这个注释后，用doxygen工具就能生成访文档了，十分方便。很多开源项目都用它来生成文档。
下面是一个例子：
http://www.latelee.org/yetanothertest/camera-html-cn/main_8c.html
stein42 2011-11-30
- 打赏
- 举报
对编译器来说是注释，
但可以用其它工具提取出来生成文档。
但可以用其它工具提取出来生成文档。
justkk 2011-11-30
- 打赏
- 举报
参数吧
