如果使用了\code，则Doxygen不会记录类
如果使用了\code，Doxygen将不会记录该代码段所在的类。
Doxygen是一个用于生成软件文档的工具，它可以根据源代码中的注释自动生成文档。在文档中，Doxygen会显示类和类的成员函数，并将它们与其相应的描述和注释关联起来，使得用户可以更容易地理解和使用代码。
在Doxygen中，可以使用\code标记来标识一段代码块，这段代码块将以纯文本的形式呈现，不会被解析为类或成员函数。这通常用于显示一段与特定类或成员函数无关的代码，或者用于显示一段较长的代码示例。
然而，由于使用了\code，Doxygen不会将这段代码与任何特定的类或成员函数关联起来。这意味着在生成的文档中，无法通过类或成员函数的页面来查找到这段代码的存在。因此，如果需要将代码与类或成员函数关联起来并在文档中展示，建议避免使用\code标记。
对于代码相关的记录，可以在注释中使用其他Doxygen标记，如\brief、\param、\return等，来提供更详细的描述和解释。这些标记将使得Doxygen能够正确地将代码与类或成员函数关联起来，并将其显示在生成的文档中的相应位置。
腾讯云相关产品和产品介绍链接地址：
相关·内容
这要么是Doxygen中的bug，要么是我遗漏了什么。它很容易复制，如下所示： 我在一个foo.h文件中有以下类： class Foo {
/** */
}; 如果我使用带有缺省配置(由doxygen -g命令生成)的Doxygen (1.8.17版本)，那么Foo类就不会
浏览 28提问于2020-04-23得票数 1
回答已采纳
1回答
我正在使用doxygen创建文档，并启用了INHERIT_DOCS选项。这对于普通方法很有效。基类的文档化将出现在重新实现该方法的类中。但是，如果我对信号或插槽执行相同的操作，doxygen将不会继承文档，成员会出现，但仍未记录。
我是不是漏掉了什么，还是有个bug？谢谢你的帮助。
浏览 6提问于2016-01-10得票数 6
我试图记录一个C++项目，其组成如下：A.hclass A { /*!\copydoc A::someAfunc() void B::someAfunc() m_pA->someAfunc();如果运行doxygen，我可以获得A类和B<
浏览 1提问于2021-05-18得票数 0
我正在记录，但无论是Appledoc还是Doxygen，我都没什么好运气。。关于这个问题，我想把重点放在氧气问题上。如果接口中的代码片段也包含一个接口或协议，also将扼杀(忽略)类级intro -我指的是在@接口上方发生的所有比特。。。为了正确地记录这个类，我们确实需要这些片段。是否有办法使doxygen将这些代码段视为代码片段和普通代码片段，而不删除类概述？下面是它的内容。
浏览 3提问于2013-12-06得票数 0
回答已采纳
1回答
我试图用doxygen在C中记录枚举值。/** @file filename.h
* @brief some descr
浏览 3提问于2014-08-27得票数 1
回答已采纳
所以我有一个项目的集合，这些项目是用doxygen记录的(而且它必须是doxygen)。我为每个项目单独运行doxygen，并使用“链接到外部文档”来连接文档。到目前为止还不错，但现在我有了第三个项目，让我们称它为app，它同时使用了libA和libB。我导入标记文件和链接对两者都有效，但它也抱怨libA主页锚点是重复的。我意识到它们是这样的，因为它们既可以通过libB直接导入，也可以直接作为libA导入，但是如果我不在app中导入libA标记文件，那么libA类的链接
浏览 2提问于2015-07-01得票数 4
我正在尝试用doxygen记录我的PHP库，但我不能使用关键字"self“配置它，让它识别我的类的成员函数的正确用法。myfunc1(){ public static function myfunc2(){}
浏览 0提问于2017-04-11得票数 3
是否有一种方法可以让DO2报告源代码是否有文档记录？是否有任何方法来识别一组C++源文件中没有详细记录的文件集？编码语言: C++
/// \param argc An integerchar** argv) /// Comments I would like to be documented in a
浏览 14提问于2021-03-16得票数 1
回答已采纳
我在用doxygen写笔记。有时，我在其中包含一个代码块，其中包含很长的行。\code this is a quite long long long long long long long longlong long long long long long long long long long long long long line正如您所看到的，stack overflow不会在这里包装我的线并提供一个水平滚动条但是，<e
浏览 3提问于2019-09-02得票数 0
回答已采纳
为了记录它，我安装了doxygen。当doxygen遇到具有以下结构的文件时，会发生一些奇怪的事情： $this->load->library('img'); public function foo(){这是唯一被跳过的文件，在
浏览 0提问于2012-05-13得票数 2
回答已采纳
2回答
SPECIAL_FUNC)(KEY key);
int a; SPECIAL_FUNC;
Bool add(KEY key); //codeBool sub(KEY key); //code...
浏览 0提问于2011-12-20得票数 2
回答已采纳
一个(或多个)安装了12.04.1 (精确)、1.7.4-3的doxygen补丁程序，如果文件名为.tcl ( Tcl文件的正常扩展名)，则doxygen将不会通过Tcl文件运行我的筛选脚本。如果扩展是其他东西，如.src，则将按预期运行筛选器。我将.tcl用于说明源的库或助手文件，而.src用于“主”程序，而不是。(是的，我有正确的文件名模式，等等) --我的整个包在CentOS 5和CentOS 6下构建得很好，在CentOS 5下，我甚至使用了我用doxy
浏览 0提问于2013-04-03得票数 4
1回答
我试图用doxygen记录代码，对于我的应用程序代码中的类，其他类的链接可以按需要工作。但如果我在“返回”或“param”中引用来自其他地方的类(例如，供应商.)没有名称空间(因为我在“use”中引用了名称空间)。它找不到它。这是否是预期的行为(因此我需要在类名前加上名称空间)？
浏览 0提问于2016-02-03得票数 0
回答已采纳
3回答
现在的问题是，我想用doxygen记录StringContainer。但是，它并不是一个真正存在的类，所以如果我这样做了：可以创建假的.h文件，以使doxygen相信类的存在，同时阻止构建系统包含类。这些文件可以具有.dox扩展名。这样，我将创建一个.dox文件，包括类定义和文档：
浏览 6提问于2012-05-11得票数 6
我正在尝试使用Doxygen来记录一个python模块--然而，__init__.py文件的存在似乎导致了问题## Nothing如果下面是我的文件，那么模块命名空间不会在Doxygen端解析：# @author me#
# Some more description即使文件中的任何类不包含__init__方法(尽管可能存在命名冲突)，
浏览 0提问于2011-07-12得票数 4
回答已采纳
4回答
有没有办法抑制Doxygen在特定文件上给出“未记录”的警告？我的项目有几个自动生成的代码头，导致它抛出成百上千个错误，使其难以筛选。
浏览 0提问于2010-08-18得票数 15
回答已采纳
单击它们时不会发生任何事情。当我使用选项卡导航到类时，(继承图和协作关系图)只显示类本身，其他什么也不会显示--即使在我知道这些图相当大的情况下也是如此。搜索不起作用。当我在搜索框中键入某些内容并按Enter键时，什么都不会发生。没有匹配类、运算符和函数的文件成员，没有匹配的类成员，没有唯一匹配的类成员，记录了但未声明或未定义的函
浏览 1提问于2012-01-05得票数 0
2回答
我正在尝试使用Doxygen来记录一个python类。该类通过d-bus公开一组属性，但这些属性在python类中没有相应的公共getter/setter。我想要做的是能够使用以下内容来记录这些属性：整个package::Class都可以工作(同样的方法会查找函数，因此它会找到正确的类)。运行doxygen时，我得到以下错误：
warning: documented
浏览 3提问于2012-10-29得票数 10
回答已采纳
如果我在一个文件中有一个我不能更改的类，但是我需要用doxygen编写文档，那么最好的方法是什么呢？我知道最好在实际的.h或.cpp文件中记录，但在这个特定的实例中，这是不可能的。我已经知道如何记录一些成员，但我不能以一种可靠的方式记录操作员。让我举个例子。下面是一个示例类，它包含一个引起问题的成员和一个正常工作的成员：{ int Bar();};
在doxy
浏览 0提问于2011-01-24得票数 3
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
