带有Doxygen的自定义标签
带有Doxygen的自定义标签是一种在代码注释中使用的特殊语法，用于生成文档和API文档。Doxygen是一个广泛使用的开源工具，用于从源代码中提取文档，并生成可读的文档和API文档。自定义标签允许开发人员为代码元素（如类、函数、变量等）添加额外的元数据，以便更好地组织和理解代码。
Doxygen支持多种自定义标签，包括：
- @author：指定代码的作者。
- @brief：提供代码元素的简短描述。
- @bug：指定代码中的已知问题。
- @copyright：指定代码的版权信息。
- @date：指定代码的日期。
- @deprecated：指定代码已被弃用。
- @details：提供代码元素的详细描述。
- @file：指定代码文件的名称。
- @fn：指定函数的名称。
- @headerfile：指定头文件的名称。
- @ingroup：指定代码元素所属的组。
- @internal：指定代码元素为内部实现。
- @li：用于列表项。
- @mainpage：指定代码的主页。
- @name：指定代码元素的名称。
- @namespace：指定命名空间。
- @param：描述函数参数。
- @return：描述函数返回值。
- @retval：描述函数返回值。
- @section：指定代码段。
- @since：指定代码的起始版本。
- @todo：指定代码的待办事项。
- @version：指定代码的版本。
使用自定义标签可以帮助开发人员更好地组织和理解代码，并生成更加详细和准确的文档和API文档。
相关·内容
2回答
我刚刚开始使用doxygen，在第一次测试运行时，我注意到创建的PDF在首页上有"created by doxygen 1.8.3.1“，后跟日期和时间。我注意到了其他类似的问题，但只针对HTML (或我没有生成的RTF )，而不是PDF
浏览 5提问于2013-04-25得票数 3
回答已采纳
3回答
使用Doxygen定制标签
doxygen
我正在尝试弄清楚是否有一种方法可以使用Doxygen创建自定义标签。我确实找到了别名配置文件选项，但这并不完全符合我的需要。基本上，在我的代码中，我希望能够编写类似这样的代码然后让Doxygen为具有此自定义标记的行创建一个列表，就像为\bug和\Doxygen可以做到这一点吗？
浏览 0提问于2009-02-11得票数 43
回答已采纳
1回答
在qtcreator中使用doxygen
linux、plugins、qt-creator、doxygen、mageia
我想在我的带有Mageia3的linux机器上使用doxygen和qt creator，我找到了一个用于此目的的qtcreator插件()。不幸的是，这是针对qt creator版本2.4 (我使用2.7)。
那么，有没有2.7版的插件，或者可以在qtcreator中使用doxygen而不使用插件呢？我是说像doxygen标签自动补全之类的.
浏览 0提问于2013-08-18得票数 1
1回答
要忽略行的Line别名
alias、doxygen
为了使公司范围内的头文件格式适应doxygen，我想创建一些被doxygen忽略的自定义标签。我想我可以用别名来做这件事，但到目前为止，我只能用其他的来替换标签。我想要实现的是：使用别名，如@company="“。不幸的是，这只会打印没有节名称的文本。
有什么想法吗？
浏览 0提问于2013-05-15得票数 0
1回答
为.ini配置文件自定义Doxygen输出
doxygen、ini
有没有办法定制包含注释的.ini配置文件的超文本标记语言输出，例如：;This is an extensive description of MyParameter (possiblyMyParameter=MyValue;@recommendedValue 5 cows目前，我在@include/@verbinclude中包含了.i
浏览 1提问于2015-10-27得票数 0
5回答
如何在Doxygen中包含自定义文件
doxygen
我想添加自定义(非项目)文件，以生成一些额外的网页与。
我(实际上)不确定这些文件应该如何命名，以及它们的内容应该如何格式化。
浏览 3提问于2010-06-16得票数 52
回答已采纳
1回答
是否有方法将自定义标签添加到doxygen输出？
doxygen
如果您使用doxygen，您会注意到某些装饰可以出现在标题栏中，用于给定函数的详细信息。这里有一个例子，它有inline装饰，另一个我见过的是static，我希望还有其他的装饰。
实际上，我正在使用doxygen来记录混合C++/Javascript项目上的Javascript，并希望在文档中添加一个async装饰，用于异步函数。我正在使用优秀的脚本对此进行处理。那么，有什么方法可以插入定制的装饰品吗？我希望语法是这样的</e
浏览 2提问于2018-11-30得票数 1
回答已采纳
1回答
语法突出显示emacs中doxygen注释中的html标记
emacs、syntax-highlighting、doxygen
我目前使用doxymacs来语法高亮显示C++文件中的doxygen注释和关键字，这是我正在进行的一个协作项目。然而，在这个项目中，有一些“计划”文件，这些文件基本上都是非常长的doxygen注释，带有大量的todos、bug等内容，所有这些文件都使用html标签来组织和呈现。目前doxymacs只突出显示"todo“和"bug”等关键字，如何才能在doxygen注释中语法突出显示html标记？我可以通过切换到&q
浏览 0提问于2011-07-17得票数 2
回答已采纳
1回答
Doxygen自定义标签
testing、doxygen
我想在doxygen中创建一个自定义标记，其中包含票证编号和门工具的链接 # @sw_requirement{TESTID, https://xyz} 对于一个参数，尝试了以下方法： ALIASESDoxygen版本1.9.2 我尝试了以下方法： ALIASES += sw_requirement{2}=@xrefitem sw_requirement \"Requirement(s) underTest\" \"requirement based tests\"
浏览 35提问于2021-11-17得票数 0
3回答
使用Doxygen for Visual Studio 2008项目
c++、visual-studio-2008、documentation、doxygen
我想为我的解决方案中的一个项目安装和创建Doxygen文档。你能一步一步地告诉我这个过程吗？我已经在谷歌上搜索过了，但没有找到这样的信息。
浏览 4提问于2012-10-10得票数 0
回答已采纳
2回答
如何在Objective-C/Swift中记录自定义类的描述？
objective-c、xcode、swift
我知道你可以使用/(三重斜杠)来注释变量，甚至可以使用/**来对函数等进行doxygen风格的注释，但是有没有一种方法来记录自定义类本身呢？
浏览 1提问于2015-03-09得票数 0
2回答
在doxygen布局中添加新的用户选项卡
doxygen、doxywizard
我刚开始使用doxygen 1.8.7。我正在尝试将架构图添加到使用doxygen为我的C#项目生成的API文档的一部分。我生成了默认的doxygen布局文件(DoxygenLayout.xml)，并通过添加以下更改对其进行了编辑- <tab type="mainpage" visible="/tab>
<tab type="examples"
浏览 8提问于2014-05-02得票数 3
2回答
如何使用Doxygen记录应用程序源文件
c++、doxygen
程序的树形结构如下： |---- lib1 |----include |----src |---- app1 |---- app2App1和app2是使用lib1和lib2的两个应用程序做这件事的合适方式是什么？
谢谢
浏览 0提问于2017-09-19得票数 0
2回答
如何从doxygen中排除python代码中的某些方法？
python、doxygen
我想从python代码创建doxygen文档，但我想从类中排除一些方法。ENABLE_PREPROCESSING = YES
在我所做的代码中#ifndef DOXYGEN_SHOULD_SKIP_THIS ...
浏览 3提问于2018-09-28得票数 0
1回答
在doxygen中，/<&/之间的区别是什么？
documentation、doxygen
我用doxygen记录我的代码，发现有一个doxygen标签列表，其中两个是: 1- /<这些标签之间的区别是什么？
我试着用谷歌搜索它，但谷歌在搜索时忽略了这些标签！！
浏览 0提问于2013-02-11得票数 0
回答已采纳
1回答
tags Doxygen vs Intellisense Eclipse
php、eclipse、intellisense、doxygen
我使用的是Eclipse (Mars2) Doxygen、Eclox和PDT。l'objet XXXX * @param Boolean $a blablabla */
在Doxygen中是可以的，但在Eclipse Intellisense中，我看到了@fn，@brief，@details。我必须使用哪些标签才能在Doxygen和Eclipse Intell
浏览 0提问于2016-05-31得票数 0
1回答
氧基团和模索引
c++、doxygen、doxygen-addtogroup
我正在为我的项目创建一个Doxygen文档。最近，我使用\addtogroup标签对相关类进行了分组。在此之后，我的文档中有一个模块选项卡。它显示了所有模块。我想在同一页的模块名称下面添加一些描述。我怎样才能使用Doxygen来做呢？/*! \addtogroup test test * @{
*/
浏览 5提问于2010-03-30得票数 4
回答已采纳
1回答
停止doxygen搜索(并假设)源代码中不存在的变量
documentation、doxygen
我在它的设计之外使用doxygen，但完全在它的能力之内。我有一堆本质上是文本的文件，附加了一些doxygen标签。我正在成功地生成doxygen输出。然而，不知何故，doxygen偶尔会发现它认为是变量的东西，并使用周围的文本对其进行文档记录，这导致了许多令人困惑的文档。我看不到这些异常之间有任何直接的关系，只是它们在每次运行时都会产生相同的输出，我能看到<em
浏览 0提问于2010-12-14得票数 0
回答已采纳
3回答
我可以写类似于@code或@逐字的doxygen别名吗？
doxygen
我需要一个别名来标记命令行代码，该代码设置在带有白色文本的黑色背景上，可以这样使用：C:\temp>echo Hello, world!@endcmd
普通doxygen的别名不能做到这一点(多行嵌套的"\temp")，但是@code和@verbatim可以。但是，我不能使用它们，因为它们被格式化为带有黑色文本的白色背景，所以用自定义的CSS覆盖
浏览 1提问于2012-02-03得票数 5
1回答
根据特定的cmake自定义目标设置变量
variables、cmake
我在我的CMakeLists.txt中定义了这样一个目标if(DOXYGEN_FOUND) configure_fileCMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) ${DOXYGEN_EXECUTABLEWORKING_D
浏览 2提问于2014-08-20得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频活动推荐
腾讯云开发者
