首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

doxygen引用实体时如何包含描述

Doxygen是一种用于生成软件文档的工具,它支持多种编程语言,包括C++、Java、Python等。在使用Doxygen时,可以通过引用实体来包含描述。

引用实体是指在文档中引用其他地方定义的实体,例如函数、类、变量等。通过引用实体,可以在文档中直接使用实体的描述,而无需重复编写。

在Doxygen中,可以使用以下方式来引用实体并包含描述:

  1. 使用@ref标签:通过在文档中使用@ref标签,可以引用其他地方定义的实体,并在生成的文档中包含实体的描述。例如:
  2. 使用@ref标签:通过在文档中使用@ref标签,可以引用其他地方定义的实体,并在生成的文档中包含实体的描述。例如:
  3. 在上述例子中,@ref functionName "函数名"引用了名为functionName的函数,并在生成的文档中包含了函数的描述。
  4. 使用@copydoc标签:通过在文档中使用@copydoc标签,可以复制其他地方定义的实体的描述。例如:
  5. 使用@copydoc标签:通过在文档中使用@copydoc标签,可以复制其他地方定义的实体的描述。例如:
  6. 在上述例子中,@copydoc functionName复制了名为functionName的函数的描述,并在生成的文档中包含了函数的描述。

通过以上方式,可以在使用Doxygen生成的文档中引用实体并包含描述,提高文档的可读性和维护性。

腾讯云相关产品和产品介绍链接地址:

  • 腾讯云文档中心:https://cloud.tencent.com/document/product
  • 腾讯云开发者手册:https://cloud.tencent.com/developer/doc/1199
页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

  • SQL Server2000导出数据包含主键、字段默认值、描述等信息

    时经常用SQL Server2000自带的导出数据向导将数据从一台数据库服务器导出到另一台数据库服务器: 结果数据导出了,但表的主键、字段默认值、描述等信息却未能导出,一直没想出什么方法,...说明 1.生成SQL脚本应注意包含扩展属性、主键、默认值等信息; 如何导出?...SQL Server2000生成SQL脚本导出字段描述、主键和默认值等信息 SQL Server2000生成SQL脚本默认没有生成字段描述、主键和字段默认值等信息,但这些信息都非常重要,...是必须要生成的,所以在生成SQL脚本必须手工设置下: 1.生成字段描述:切换到"设置格式"选项卡,钩选"包括扩展属性" 2.生成主键和字段默认值:切换到"选项"选项卡,钩选"

    1.2K110

    Excel: 引用数据源发生移动如何不改变引用的单元格地址

    文章背景:在Excel中,公式引用无效单元格将显示 #REF! 错误。当公式所引用的单元格被删除或被粘贴覆盖最常发生这种情况。...在编写单元格公式,不推荐在函数中使用显式单元格的引用(如:"=A2","=A3"等)。当引用的数据源发生移动,为了确保引用的单元格地址不变,可以配合使用indirect函数和address函数。...如果省略 reference,则假定是对函数 ROW 所在单元格的引用。 参考资料: [1] 如何更正 #REF!...E5%A6%82%E4%BD%95%E6%9B%B4%E6%AD%A3-ref-%E9%94%99%E8%AF%AF-822c8e46-e610-4d02-bf29-ec4b8c5ff4be) [2] 引用数据源发生移动...,如何使引用的单元格不变(https://club.excelhome.net/thread-1096201-1-1.html?

    3.9K30

    doxygen教程_genedoc教程

    它可以依据程序本身的结构,将程序中按规范注释的批注经过处理生成一个纯粹的参考手册,通过提取代码结构或借助自动生成的包含依赖图(include dependency graphs)、继承图(inheritance...安装完后进行Doxygen配置需要关联graphviz和HTML Help WorkShop的安装路径。...到上一步Doxygen已经完全配置好,可以在Run中点击运行了,但为了保存以上配置信息,可以将配置好的文件存一个.cfg文件,之后再运行Doxygen只需要将该文件用Doxygen打开,改变第(1)步中的输入...在Doxygen中,主要通过以下方法将注释块标识成详细(detailed)描述:  JavaDoc风格,在C风格注释块开始使用两个星号’*’: /** * ......引用了某个枚举,Doxygen会在该枚举处产生一个链接eg:@enum CTest::MyEnum @var 引用了某个变量,Doxygen会在该枚举处产生一个链接 @class 引用某个类,格式:@

    4.4K30

    面向 C++ 的现代 CMake 教程(四)

    最后,我们应该检查事物在运动的表现:执行程序并检查其内存。内存在使用后是否被正确释放?我们是否正确地访问了初始化的数据?或者代码试图解引用一些悬空指针?...包含你使用的(include-what-you-use) 以下是从官方网站对 include-what-you-use 的描述包含你使用的的主要目标是去除不必要的#include。...让我们找出如何使用它与 CMake 一起工作——这将为您需要它们采用其他工具铺平道路。 Memcheck Memcheck 在调试内存问题可能不可或缺。...可以在 Doxygen 的 docblocks 描述中找到更多信息(请参阅 进一步阅读 部分中的链接)。...install(EXPORT)中引用CalcTargets导出名称。

    58300

    NumPy 1.26 中文文档(五十三)

    @param 为函数参数开始一个参数描述,后跟参数的描述。检查参数的存在,并在缺少或不在函数声明或定义中存在该(或任何其他)参数的文档给出警告。 @return 开始为函数返回值描述。...包含指令 Breathe 提供了广泛的自定义指令,允许将 Doxygen 生成的文档转换为 reST 文件。...@param 开始一个函数参数的参数描述,参数名为,后跟参数的描述。检查参数的存在,并在函数声明或定义中缺少此(或任何其他)参数的文档给出警告。 @return 为函数设置返回值描述。...包含指令 Breathe 提供了各种自定义指令,允许将 Doxygen 生成的文档转换为 reST 文件。...包含指令 Breathe提供了各种自定义指令,允许将Doxygen生成的文档转换为 reST 文件。

    10910

    Github 项目推荐 | 真实全景图像强化学习 AI 平台 —— Matterport3DSimulator

    参考 Matterport3DSimulator 和 Room-to-Room (R2R) 导航数据集在下述的论文中有详细描述: https://arxiv.org/abs/1711.07280 如果你要使用模拟器或者数据集...,请引用以下论文: @article{mattersim, title={{Vision-and-Language Navigation}: Interpreting visually-grounded...sudo apt-get install libopencv-dev python-opencv freeglut3 freeglut3-dev libglm-dev libjsoncpp-dev doxygen...make cd ../ 用 Cmake 构建 OSMESA mkdir build && cd build cmake -DOSMESA_RENDERING=ON .. make cd ../ 要为doxygen...目录中的 C ++ 类构建 html 文档,请运行以下命令并导航到 doxygen / html / index.html: doxygen Demo 这些是非常简单的 Demo 演示,旨在说明模拟器如何

    2K120

    面向 C++ 的现代 CMake 教程(五)

    我们将通过回顾章节列表、回顾其内容,并选择其中描述的技巧和工具来开始规划,以构建我们的计算应用程序: 第1章,CMake 的初步步骤: 第一章为我们提供了关于 CMake 的基本信息——如何安装它以及如何使用其命令行构建准备好的项目...我们在这一章描述了几种依赖管理方法。选择正确的一个并不太困难:通常推荐使用FetchContent实用程序模块,最为方便(除非我们正在解决本章中描述的具体边缘情况)。...它还通过PUBLIC_HEADER属性引用calc.h头文件,该属性可以在配置的包含目录中找到(感谢生成器表达式提供特定模式的适当路径——构建或安装)。...如果你对它是如何工作的细节感兴趣,你会在进一步阅读部分找到合适的参考资料。 更重要的是,看看包含指令:它们指的是我们之前通过calc_obj目标和BuildInfo模块提供的头文件。...接下来,我们简要介绍了如何使用 Doxygen 生成文档以及如何使其更具吸引力。最后,我们展示了如何将项目安装到系统上,创建可重用的 CMake 包,以及如何配置和使用 CPack 生成二进制包。

    14400

    物联网设备端开发-开发环境搭建

    为了更好的学习物联网设备端相关知识和实践,基于之前的 iot hub c sdk 整理并重写了 iot-hub-device-c-sdk 以下针对该仓库,描述如何搭建相应的开发环境。...工程的编译框架构建基于cmake gcc:linux上编译器 g++:提供googletest单元测试支持 googletest:提供工程的单元测试框架 gcovr:提供单元测试覆盖率统计 git:代码版本控制 doxygen...:提供代码注释格式化和注释可视化支持 graphviz:配合doxygen使用,提供头文件依赖视图 vscode需要安装以下插件: C/C++:提供C/C++语言开发支持 Doxygen Documentation...Generator:提供doxygen风格注释生成 markdownlint:markdown格式化校验,提高文档质量 Code Spell Checker:单词拼写检测,提高代码质量 GitLens...Windows子系统 在Microsoft Store中下载Ubuntu 软件安装 apt-get update # 安装所需软件 apt-get install git cmake gcc g++ doxygen

    3.6K41

    老外的嵌入式编程规范(值得一看)

    for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 在头文件中总是包含带有extern关键字的c++检查 每个函数都必须包含doxygen-enabled...所有枚举成员必须是大写的 结构/枚举必须遵循doxygen文档语法 在声明结构体,它可以使用以下三种不同的选项之一:   1....1个嵌套语句 每个复合语句必须包含单个缩进;嵌套语句,每个嵌套包含1个缩进大小 /* OK */ if (c) { do_a(); } else { do_b(); } /* Wrong...这不适用于void函数 函数可以包含其他doxygen关键字,如note或warning 在参数名和描述之间使用冒号: /** * \brief Sum `2` numbers...(x) : (y)) 10 头/源文件 ---- 在文件末尾留下一个空行 每个文件都必须包括文件的doxygen注释和后跟空行的简要描述(使用doxygen) /** * \file

    1.8K20

    如何注释你的文档-doxygen

    Doing nothing, Doxygen will produce a nice cross referenced HTML-izedversion of the code....It is veryeasy to learn the extension to C++ comments that doxygen uses....首先,Doxygen在不做任何额外的工作下可以很容易地把我们的代码生成相应的HTML格式的文档。然而,你也可以通过嵌入类似如何使用你声明过的类的用法的注释使之更有用。...学习Doxygen的C++注释方法很容易。有很多注释的格式可以被Doxygen认同,参见Doxygen的官网,尤其是这个部分,当然也仅仅是一个子集而已。...cxx files. 1) 在代码之前注释, 2) 针对类的成员和参数,注释也可以在其后面, 3) 注释有两种方式:简单的(一行)或者详细的或者两者都有, 4) 把类型代码的注释(类和用法描述

    78220

    【rainbowzhou 面试39101】综合提问--描述下当你遇到紧急的项目需求变更,你如何重新规划测试活动的?

    今天和大家聊聊,在过往的测试经历中,都会遇到的一种情况:某个项目中,客户反馈紧急需求变更,你们团队如何快速响应规划相关活动,达成他们诉求的,下面是我针对该情况的经历分享,希望能够对你有所帮助。...举个例子,说明一下我是如何分析需求变更的影响范围和程度的。 我在一个营销平台的项目中,负责测试自动营销触达系统。...在项目进行到一半的时候,我收到了一个紧急的需求变更,要求在触达再增加一个线上优惠券功能,因为实际业务场景中,线上线下优惠券均有使用,且线上优惠券的适用范围和条件更灵活。

    22550

    文档代码同源

    这样可以:1.修改代码的时候就及时修改文档,使得文档和代码及时保持一致;2.阅读代码,增加代码的可读性。评审代码的时候,尤其是修改时后,即对文档一同评审。...(后面有文章做一个的Doxygen介绍。)这里简单的介绍一下DoxygenDoxygen 是一个程序的文档产生工具,可将程序中的特定注释转换成为说明文件。比如说对于以下这段注释: ?...如模块中编写,说明实现了哪些需求。 ? ? 这些都是超文本标签,点击后迅速转到需求定义处可查看。 ? 2.2、每日检查 该方法的核心内容,就是每日检查。...与需求类似,写一个Excel表格,包含:模块;检查人;日期;问题描述的跟踪表;检查完成后提交至版本库,由对应的工程师承接修改。 ? ?...代码同源的模块如何被复用呢?首先,公司内部要有完善的版本控制机制。任何代码,全局只有一份。对于svn的版本库、git的版本库,有不同的办法。

    51540

    值得一看:老外的嵌入式编程规范

    for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 在头文件中总是包含带有extern关键字的c++检查 每个函数都必须包含doxygen-enabled...所有枚举成员必须是大写的 结构/枚举必须遵循doxygen文档语法 在声明结构体,它可以使用以下三种不同的选项之一: 1....1个嵌套语句 每个复合语句必须包含单个缩进;嵌套语句,每个嵌套包含1个缩进大小 /* OK */ if (c) { do_a(); } else { do_b(); } /* Wrong...这不适用于void函数 函数可以包含其他doxygen关键字,如note或warning 在参数名和描述之间使用冒号: /** * \brief Sum `2` numbers...(x) : (y)) 10 头/源文件 ---- 在文件末尾留下一个空行 每个文件都必须包括文件的doxygen注释和后跟空行的简要描述(使用doxygen) /** * \file

    1.2K40
    领券