首页 > 其他分享 >Doxygen块状注释规范

Doxygen块状注释规范

时间:2023-08-25 15:34:01浏览次数:36  
标签:Doxygen const brief param 注释 块状 file size

普通注释

 

一般普通注释中有详细注释和简要注释,简要注释有多种标识方法,推荐使用@brief命令强制说明

/**
* @brief 简要注释. 详细注释
* 详细注释
*/

简要注释结束的标志是一个点号,或一个空行。

文件头注释

/** 
* @file [file-name]
* @brief brief description for the file.
* @author <list of authors>
* @email <email>
* @date <date>
* @license <license>
* @version <version number>
*
* detailed description for the file.
*/

类和成员注释

/**
* @class <class‐name> [header‐file] [<header‐name]
* @brief brief description
* @author <list of authors>
* @note
* detailed description
*/

int var; /**< Detailed description after the member */

函数注释

/**
* @brief		can send the message
* @param[in]	canx : The Number of CAN
* @param[in]	id : the can id	
* @param[in]	p : the data will be sent
* @param[in]	size : the data size
* @param[in]	is_check_send_time : is need check out the time out
* @note	Notice that the size of the size is smaller than the size of the buffer.		
* @return		
*	+1 Send successfully \n
*	-1 input parameter error \n
*	-2 canx initialize error \n
*	-3 canx time out error \n
* @par Sample
* @code
*	u8 p[8] = {0};
*	res_ res = 0; 
* 	res = can_send_msg(CAN1,1,p,0x11,8,1);
* @endcode
*/							
extern s32 can_send_msg(const CAN_TypeDef * canx,
			const u32 id,
			const u8 *p,
			const u8 size,
			const u8 is_check_send_time);

其他还有枚举注释、模块注释等,在此不一一列举,下面贴一下Doxygen中的特殊命令表

命令 字段名 语法
@file 文件名 file [< name >]
@brief 简介 brief
@author 作者 author
@mainpage 主页信息 mainpage [(title)]
@date 年-月-日 date
@author 版本号 version
@copyright 版权 copyright
@param 参数 param [(dir)] < parameter-name>
@return 返回 return
@retval 返回值 retval
@bug 漏洞 bug
@details 细节 details
@pre 前提条件 pre
@see 参考 see
@link 连接(与@see类库,{@link http://www.google.com}) link < link-object>
@throw 异常描述 throw < exception-object>
@todo 待处理 todo
@warning 警告信息 warning
@deprecated 弃用说明。可用于描述替代方案,预期寿命等 deprecated
@example 弃用说明。可用于描述替代方案,预期寿命等 deprecated

标签:Doxygen,const,brief,param,注释,块状,file,size
From: https://www.cnblogs.com/takohubuki/p/17656817.html

相关文章

  • 论文解读 | ScanNet:室内场景的丰富注释3D重建
    原创|文BFT机器人大型的、有标记的数据集的可用性是为了利用做有监督的深度学习方法的一个关键要求。但是在RGB-D场景理解的背景下,可用的数据非常少,通常是当前的数据集覆盖了一小范围的场景视图,并且具有有限的语义注释。为了解决这个问题,本文介绍了一个ScanNet的大规模室内场景......
  • Dbeaver工具,导出oracle 表注释、字段注释
    --表注释SELECTtable_name,comments,'commentontable'||table_name||'is'''||comments||''';'FROMall_tab_commentsWHEREowner='用户名'ANDtable_nameIN('表名')ORDERBYtable_name;--字段注......
  • VS 智能提示、注释是英文,改为中文
    一、.NETFramework打开文件夹C:\ProgramFiles(x86)\ReferenceAssemblies\Microsoft\Framework\.NETFramework把v4.X文件夹里的zh-Hans文件夹复制到你需要的版本文件夹里。重启VS即可。例如:我最近在使用.NetFarmworker4.0开发项目,然后发现没有注释,那就复制......
  • 软件测试 | Java程序的注释
    在任何编程语言之中,都存在注释,注释的主要功能是让其他用户可以方便地阅读每段程序,提高程序的可读性,还可以通过注释屏蔽掉一些暂时不用的语句,等需要时直接取消此语句的注释即可,在Java中根据功能的不同,注释主要分为单行注释、多行注释、文档注释3种,下面分别进行介绍。单行注释,就是在......
  • vs code 出现html js css 注释不正常
    vue地方使用了<!---->注释,这是正常的,但是css部分也是使用<!---->注释,css应该使用//或/**/注释,这里错了。多次检查扩展,发现是扩展的问题,卸载vue或vetur这些扩展即可。......
  • JSON文件如何添加注释?
    JSON(JavaScriptObjectNotation)的设计是简洁和明确的,它不支持注释。这是JSON设计的决策之一,目的是使JSON保持尽可能简单和纯粹。但在实践中,很多时候,开发者确实会想在JSON文件中添加注释,以帮助解释或标记某些部分。虽然JSON标准不支持注释,但你仍然可以采取以下策略:使用替代文件:使用......
  • 注释
    注释并不会被执行,是给我们写代码的人看的  单行注释://注释 多行注释:/*注释*/     换行直接回车 文档注释:/**注释*/ 附加更改注释颜色(首先点击左上角file)   ......
  • Visual Studio 智能提示、注释是英文,改为中文
     最近建立一个新项目准备写一个小demo,新建项目时选的时.Net7。写代码的时候发现。Net7没有系统的中文注释,去官网下载的时候发现没有关于.Net7的汉化文件包,最新的汉化包是。Net5的,可能是我没找到,我这里是把.Net5汉化包放到了.Net7下面了,测试好用。一、.NETFramework打开文......
  • 《代码整洁之道 Clean Code》学习笔记 Part 1 - 命名、注释、格式
    前段时间在看《架构整洁之道》,里面提到了:构建一个好的软件系统,应该从写整洁代码做起。毕竟,如果建筑使用的砖头质量不佳,再好的架构也无法造就高质量的建筑。趁热打铁,翻出《代码整洁之道》再刷一遍。《代码整洁之道CleanCode》学习笔记Part1衡量代码质量的唯一标准:WTF/min......
  • *【学习笔记】(10) 块状链表
    块状链表(尚未完善)对于线性表,可以\(O(1)\)的访问,但是插入和删除操作是\(O(n)\)对于链表,可以\(O(1)\)的进行插入和删除,但是是\(O(n)\)的访问。于是本着分块的思想,有了块状链表。大概长这个样子。每个块的大小数量级在\(O(\sqrt{n})\),块数的量级\(O(\sqrt{n})\)主......