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

为什么doxygen不显示带注释的公共属性?

Doxygen是一款开源的自动文档生成工具,主要用于生成各种编程语言的代码文档。它可以根据源代码中的注释,生成具有良好结构和易于阅读的文档。然而,在某些情况下,Doxygen可能无法显示带注释的公共属性。

这种情况通常发生在以下两种情况下:

  1. 注释格式不符合要求:Doxygen对注释的格式要求比较严格。如果注释的格式不正确,Doxygen可能无法正确解析注释并生成文档。为了确保Doxygen可以正确识别注释,应该使用特定的注释格式,如C++中的/** ... */或///。
  2. 属性未正确声明:在一些编程语言中,特定的语法或关键字用于声明属性或成员变量。如果没有正确声明属性,Doxygen可能无法将其识别为公共属性。在这种情况下,需要确保使用正确的语法来声明属性,以便Doxygen可以正确解析和显示。

为了解决这个问题,可以采取以下步骤:

  1. 检查注释格式:确保注释使用正确的格式,符合Doxygen的要求。对于C++代码,应使用/** ... */或///格式的注释。
  2. 确保属性正确声明:在属性声明中,使用正确的语法或关键字来声明属性。这样,Doxygen才能正确解析并将其显示为公共属性。

总之,要使Doxygen显示带注释的公共属性,需要确保注释格式正确,并使用适当的语法或关键字来声明属性。这样,Doxygen才能正确解析注释并将其显示在生成的文档中。

对于腾讯云相关产品和产品介绍链接地址,由于要求不能提及具体的品牌商,建议您访问腾讯云的官方网站,了解他们提供的云计算相关产品和服务。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

文档代码同源

因为要赶工,因为市场巨大压力,文档代码对应上司空见惯。更有甚者,压根就没有文档。这里造成了很多隐性问题。 1.没有合适文档,随着时间推移,一些技术要点,设计要求,设计思路随着时间,尽归尘土。...那么怎么找一个合适方法解决这个问题呢? 2、解决方案 想想程序员为什么写或修改代码?我想即使是为了拯救地球和全宇宙,从微观上讲,也符合下列情况之一: 1.实现需求。...开源世界有一个很好用工具是Doxygen。它作用就是把代码里特殊注释抽取出来变为文档(一个类似Latex工具,非所见即所得文档编辑工具)。...(后面有文章做一个Doxygen介绍。)这里简单介绍一下DoxygenDoxygen 是一个程序文档产生工具,可将程序中特定注释转换成为说明文件。比如说对于以下这段注释: ?...以上经过Doxygen抽取编译后,会生成一个综合性文档,可在里面查到: ? 即使我们不用doxygen编译,写在代码里注释,也是不影响我们理解。只是编译后,查阅起来更方便。

51540

Doxygen工具简单使用

用他不仅可以根据注释生成文档,而且还能利用graphviz工具生成类图以及类中函数调用关系,并且支持html、latex、rtf等格式输出。...编写注释 即使不是刻意采用doxygen工具标准语法,我们也是可以用doxygen生成文档,只是他提供信息可能不是很完整,分类也不是很恰当。...不过如果使用了doxygen支持类javadoc注释方法,那么生成文档就会相当好看了。 关于简单注释规范可以参考这篇文章: 基于DoxygenC/C++注释原则。...由于最近没有什么需求,暂时研究。...样例 下面是对一个叫guisan项目利用doxygen进行文档生成结果: 事实上doxygen不仅能自动生成类属性以及方法说明,还能画出非常复杂类之间继承与聚合等关系图,在分析大型项目的时候还是非常靠谱

98220
  • doxygen教程_genedoc教程

    规范 规范综述  简要说,Doxygen注释块其实就是在C、C++注释基础添加一些额外标识,使Doxygen把它识别出来, 并将它组织到生成文档中去。  ...如果希望doxygen强行执行唯一标签,可以使用\addtogroup而非\defgroup。运作方式和\defgroup很像,但是如果该group已经定义,它默认向已存在注释中添加一个新项。... */   通过doxygen编译后,打开网页即可显示如下, 以下见名知意,不在讲解。...在实际使用中,我们可以看到具体网页展示如下。   在图中有个BSP下LED模块,这个模块就是承载驱动文件LED。具体代码如下,为了显示效果,我把函数注释删除了。...本站仅提供信息存储空间服务,拥有所有权,承担相关法律责任。如发现本站有涉嫌侵权/违法违规内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

    4.4K30

    NumPy 1.26 中文文档(五十三)

    无处不在整数类型特殊化。它不支持任何真实类型。 参数 Tp: 整数类型。需要是整数类型。 参数 N: 元素数量。 公共函数 DoxyLimbo() 默认构造函数。初始化任何内容。...整数类型专业化,属于无处。它不支持任何实际类型。 Param Tp: 整数类型。必须是整数类型。 Param N: 元素数量。 公共函数 DoxyLimbo() 默认构造函数。什么也初始化。...受保护属性 p_data[] 内联注释示例。...不支持任何真实类型整数类型特化。 参数 Tp: 整数类型。 必须是一个整数类型。 参数 N: 元素数量。 公共函数 DoxyLimbo() 默认构造函数。初始化任何内容。...保护属性 p_data[] 行内注释示例。 常见 Doxygen 标签: 注意 更多标签/命令,请参考www.doxygen.nl/manual/commands.html。

    10910

    利用Doxygen生成代码文档

    Doxygen是一个代码文档生成工具。它从代码文件中提取注释并可生成多种文档形式。如:网页文档HTML,RTF (MS-Word),PDF等等。同时也可生成函数之间调用和文件依赖关系图表。...doxygen安装 使用apt安装doxygen sudo apt install doxygen 使用最新版二进制安装(该种方式想对于第一种,可安装最新版本) doxygen下载页面: https...图片 安装graphviz Graphviz是开源图形可视化软件。它可以将结构化信息以图表形式显示出来。doxygen可以调用Graphviz显示函数调用关系。...如果需要生成chm文件,可将doxygen生成网页文件拷贝至windows环境下,然后用htmlhelp来生成chm文件。 注释和文档效果 头文件中添加如下函数注释。...其实还有其他风格。可以查看下面的网址了解: https://www.doxygen.nl/manual/docblocks.html#cppblock 文档中对应显示效果如下。

    1.7K40

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

    这可以警告我们代码格式不正确,甚至在我们允许情况下修复突出显示问题。...用双星号 /** 打开注释块是非常重要。可以在 Doxygen docblocks 描述中找到更多信息(请参阅 进一步阅读 部分中链接)。...此外,注释中任何遗漏更新都有可能在代码审查期间被发现。 许多开发者会抱怨 Doxygen 提供设计过时,这让他们犹豫是否向客户展示生成文档。别担心——有一个简单解决方案可以解决这个问题。...您可能担心将 Doxygen 添加到没有从开始就使用文档生成较大项目中会很困难。要求开发者在每个函数中添加注释工作量可能让开发者感到不堪重负。...处理公共头文件 install(TARGETS)文档建议我们在库目标的PUBLIC_HEADER属性中(用分号分隔)指定公共头文件: chapter-11/02-install-targets/src/

    58500

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

    作为维护人员,如果收到补丁明显与周围代码编码风格不同,这是令人沮丧。这是尊重人,就像某人穿着泥泞鞋子走进一间一尘房子。   ...for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 在头文件中总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...注释,即使函数是静态 使用英文名称/文本函数,变量,注释 变量使用小写字母 如果变量包含多个名称,请使用下划线。...uint8_t* t = (uint8_t*)var_width_diff_type 始终尊重项目或库中已经使用代码风格 03 注释相关规则 ---- 不允许以//开头注释。...(x) : (y)) 10 头/源文件 ---- 在文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file

    1.8K20

    Could NOT find Doxygen (missing: DOXYGEN_EXECUTABLE)

    从源代码生成文档 Doxygen 是从注释 C++ 源代码生成文档事实上标准工具,但它也支持其他流行编程语言,例如 C、Objective-C、C#、PHP、Java、Python、IDL(...可以配置 doxygen 以从未记录源文件中提取代码结构。这对于在大型源代码分发中快速找到您方式非常有用。...Doxygen 还可以通过包括依赖图、继承图和协作图方式将各种元素之间关系可视化,这些都是自动生成。...还可以使用 doxygen 创建普通文档(就像我为 doxygen 用户手册和网站所做那样)。 Doxygen 是在 Mac OS X 和 Linux 下开发,但设置为高度便携。...此外,还有适用于 Windows 可执行文件。

    2.4K20

    这才是理想中 C 语言编程规范

    作为维护人员,如果收到补丁明显与周围代码编码风格不同,这是令人沮丧。这是尊重人,就像某人穿着泥泞鞋子走进一间一尘房子。   ...for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 在头文件中总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...注释,即使函数是静态 使用英文名称/文本函数,变量,注释 变量使用小写字母 如果变量包含多个名称,请使用下划线。...uint8_t* t = (uint8_t*)var_width_diff_type 始终尊重项目或库中已经使用代码风格 03 注释相关规则 不允许以//开头注释。...(x) : (y)) 10 头/源文件 在文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file

    2.5K20

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

    作为维护人员,如果收到补丁明显与周围代码编码风格不同,这是令人沮丧。这是尊重人,就像某人穿着泥泞鞋子走进一间一尘房子。...for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 在头文件中总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...注释,即使函数是静态 使用英文名称/文本函数,变量,注释 变量使用小写字母 如果变量包含多个名称,请使用下划线。...uint8_t* t = (uint8_t*)var_width_diff_type 始终尊重项目或库中已经使用代码风格 03 注释相关规则 ---- 不允许以//开头注释。...(x) : (y)) 10 头/源文件 ---- 在文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file

    1.2K40

    使用VA助手如何快速添加注释(按doxygen注释规范)

    其中,对命名空间注释模板内容demo粘贴如下: /// @namespace ??? /// @brief ??? ? 第三步:添加对类(Class)注释模板,见图4....第四步:添加对成员函数(method)注释模板,见图5。 ?.../// @brief 导出符号定义 用法:简单举个例子,比如我们对于filter_t.h头文件想给出注释,我们只要在VS中, 输入「//Header」,即可得到如下注释行。...修改下上面的函数功能,写上你对这个函数功能具体注释即可。 那么,我们为什么要进行按照doxygen注释规范来进行注释呢,这样做有什么好处呢?...我们可以使用上述注释,快速生成如下图所示库说明文档。 ? 至于doxygen具体使用方法,已经在【3D视觉工坊】知识星球中给出了介绍,如果愿意学习了解同学,可以前往查看。

    3.8K20

    Rust API 指南:文档

    但是,一个示例最应该表明为什么要使用这个条目。 // 这是使用clone()不良示例。它机械地显示*如何* // 调用clone(),但没有显示出*为什么*要这样做。...这使得 /// `src`中内存不变。 /// /// # 安全 /// /// 除了接受原始指针之外,这是不安全,因为它在语义上 /// 将值移出src,而阻止未来使用src。...html_root_url属性告诉rustdoc在编译下游crates时如何为crate中项目创建URL。没有它,依赖于您cratecrate文档中链接将不正确。 #!...GIT_COMMITTER_DATE=$(git log -n1 --pretty=%aD) git tag -a -m "Release 0.3.0" 0.3.0 git push --tags 首选注释标签...,因为如果存在任何注释标签,则某些Git命令会忽略未注释标签。

    2K30

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

    可执行文件只为最终用户而设计,并实现一个用户界面,显示底层库功能。...我们项目也将如此,以下原因是: 定义几个库和可执行文件(用于测试和生产)将使项目保持组织性并保持干燥. 目标属性和传递使用要求(传播属性)使配置接近目标定义。...此外,在本章中,我们讨论了两个测试框架:Catch2 和 GTest gMock;对于这个项目,我们将使用后者。为了获得清晰覆盖信息,我们将使用 LCOV 生成 HTML 报告。...它还通过PUBLIC_HEADER属性引用calc.h头文件,该属性可以在配置包含目录中找到(感谢生成器表达式提供特定模式适当路径——构建或安装)。...,CMake 在这方面也例外:它提供了进行简单算术、位运算、字符串处理、列表和文件操作工具。

    14400

    Ubuntu16:cmake生成Makefile编译caffe过程(OpenBLASCPU+GPU)塈解决nvcc warning:The compute_20, sm_20

    之前在ubuntu14下实现了Caffe编译(参见去年写博客 《 Ubuntu14:cmake生成Makefile编译caffe过程(OpenBLAS/CPU only)》)。...最近将系统升级到ubuntu16,新电脑显示也支持CUDA了,重新编译Caffe时发现还依赖库还是有点不同,在这里记下来。...独立显卡 NVIDIA GTX965M 软件环境 ubuntu 16.04 NVIDIA driver 378 CUDA8.0 cudnn 5.1 编译环境准备 安装编译Caffe所需依赖库...// doxygen用于文档生成 可不安装 编译caffe 以下是编译caffe脚本(解压,生成Makefile,编译,安装全过程) build_caffe.sh #!...,如果指定--Wno-deprecated-gpu-targets选项则在编译Caffe时会产生如下编译警告 nvcc warning : The ‘compute_20’, ‘sm_20’, and

    3.1K80

    前端学习(9)~css学习(三):样式表和选择器

    CSS作用就是给HTML页面标签添加各种样式,定义网页显示效果。简单一句话:CSS将网页内容和显示样式进行分离,提高了显示功能。 css最新版本是css3,我们目前学习是css2.1。...接下来我们要讲一下为什么要使用CSS。...如果一个属性有多个值的话,那么多个值用 空格 隔开 举例: p{color: red;} css代码注释 格式: /* 具体注释...注意备选样式表中,title属性不要忘记写,不然显示不出来效果。现在来看一下效果:(在IE中打开网页) ?...正确思路,就是用所谓“公共类”思路,就是我们类就是提供“公共服务”,比如有绿、大、线,一旦携带这个类名,就有相应样式变化。

    78010

    ASP.NET Core WebApi使用Swagger生成api说明文档看这篇就够了

    为什么使用Swagger作为REST APIs文档生成工具 Swagger 可以生成一个具有互动性API控制台,开发者可以用来快速学习和尝试API。...它包括针对公共方法内置测试工具。 如何使用vs2017安装Swashbuckle呢?...启用XML 注释 可使用以下方法启用 XML 注释: 右键单击“解决方案资源管理器”中项目,然后选择“属性” 查看“生成”选项卡“输出”部分下“XML 文档文件”框 ?...启用 XML 注释后会为未记录公共类型和成员提供调试信息。...通过上面的操作可以总结出,Swagger UI 显示上述注释代码  元素内部文本作为api大注释! 当然你还可以将 remarks 元素添加到 Get 操作方法文档。

    3.3K10

    用于三维点云语义分割标注工具和城市数据集

    摘要 非结构化三维点云精确语义分割需要大量标签训练数据进行深度学习,然而,目前还没有免费专门软件可以有效地标注大型3D点云,作者通过引入PC-Annotate(一种用于3D点云研究公共标注工具...用户对PC Annotate学习曲线如图5所示,图表显示PC Annotate对用户友好。在标记了几个帧后,新用户标注时间缩短了。...Excel文件包含x、y、z值、强度、反射率、环、噪波和每个点范围,这些属性在使用深度学习算法进行语义分割时非常有用。...图9 点云城市数据集代表性标注框架,用Point Cloud标记,最后一列显示已配准标签帧数据。 表3,用于语义分割任务流行当代3D点云数据集,室内数据集以红色突出显示。...总结 训练有效点云深度学习模型需要大量标签数据,然而,目前还没有有效公共工具来注释大型点云数据集,本文通过引入PC Annotate—一种用户友好3D点云综合公共标注工具,填补了这一空白,该工具不仅能够高效地标记大型点云

    2.1K10
    领券