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

如何让doxygen在.F90文件中查看预处理器宏的文档?

在.F90文件中,要让Doxygen查看预处理器宏的文档,可以按照以下步骤进行操作:

  1. 确保Doxygen已经正确安装并配置好了环境。
  2. 在.F90文件中,使用预处理器宏定义需要查看文档的代码段。
  3. 在Doxygen配置文件(通常为doxygen.config)中,找到以下配置项并进行相应设置:
    • 设置ENABLE_PREPROCESSINGYES,启用预处理器功能。
    • 设置MACRO_EXPANSIONYES,允许宏展开。
    • 设置EXPAND_ONLY_PREDEFYES,只展开预定义的宏。
    • 设置PREDEFINED为你想要查看文档的预处理器宏,多个宏之间用空格分隔。
    • 例如:
    • 例如:
  • 运行Doxygen生成文档。
  • 可以通过命令行执行doxygen doxygen.config来生成文档,也可以使用Doxygen提供的图形界面工具进行操作。
  • 在生成的文档中,找到对应的.F90文件,预处理器宏的文档应该会显示在相应的代码段中。

需要注意的是,Doxygen对于预处理器宏的文档生成有一定的限制,它只能展示已经定义的宏,无法展示未定义的宏。因此,在使用Doxygen生成文档之前,确保所需的宏已经在代码中正确定义。

此外,腾讯云并没有与Doxygen直接相关的产品或服务,因此无法提供相关的推荐产品和链接地址。

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

相关·内容

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

优秀文档确实能引导一个完全新手几秒钟内找到他们想要查看代码行。遗憾是,缺失文档问题常常被一笔勾销。难怪——这需要很多技巧,而且我们许多人并不擅长。此外,文档和代码真的可以很快分道扬镳。...此外,注释任何遗漏更新都有可能在代码审查期间被发现。 许多开发者会抱怨 Doxygen 提供设计过时,这他们犹豫是否向客户展示生成文档。别担心——有一个简单解决方案可以解决这个问题。...现在我们可以享受我们生成 HTML 文档现代风格,并自豪地与世界分享。 摘要 本章,我们介绍了如何Doxygen,这个文档生成工具,添加到 CMake 项目中,并使其变得优雅。...所有这些准备将为本章我们将要涵盖最后方面铺平道路:使用 CPack 生成各种包管理器不同操作系统认识归档文件、安装程序、捆绑包和包。这些可以用来携带构建工件、可执行文件和库。...这对于一个非常基础打包情况解决了打包问题。现在,让我们学习如何处理更高级场景。 创建高级配置文件 如果你管理不仅仅是单个目标导出文件,那么配置文件包含几个可能是有用

58700

NumPy 1.26 中文文档(五十三)

馈送 Doxygen 并非所有的头文件都会自动收集。你必须在 Doxygen 子配置文件添加所需 C/C++ 头文件路径。...子配置文件唯一名称为 .doxyfile,通常可以包含有文档化头文件目录附近找到。如果靠近(2 深度)你想添加文件路径没有配置文件,则需要创建一个新配置文件。...引导 Doxygen 并非所有的头文件都会被自动收集。你必须在 Doxygen 子配置文件添加所需 C/C++ 头文件路径。...子配置文件唯一名称是.doxyfile,您通常可以包含文档文件目录附近找到它。如果您想添加文件所在路径没有配置文件,您需要创建一个新配置文件。...Doxygen 文档生成 并非所有标头文件都会自动收集。您必须在 Doxygen 子配置文件添加所需 C/C++ 标头路径。

11010
  • CMake 秘籍(七)

    本章,我们将涵盖以下食谱: 使用 Doxygen 构建文档 使用 Sphinx 构建文档 结合 Doxygen 和 Sphinx 引言 文档在所有软件项目中都是必不可少:对于用户...Doxygen(www.doxygen.nl)是一个非常流行源代码文档工具。您可以代码添加文档标签作为注释。...运行 Doxygen 将提取这些注释并在 Doxyfile 配置文件定义格式创建文档Doxygen 可以输出 HTML、XML,甚至是 LaTeX 或 PDF。...需要注意是,我们需要确保系统上存在构建文档所需工具(本例Doxygen 和 Perl)。...CMake 3.9 添加了一个新改进FindDoxygen.cmake模块。实现了便利函数doxygen_add_docs,它将作为我们本食谱中介绍

    16100

    doxygen教程_genedoc教程

    1.DoxygenDoxygen能将程序特定批注转换成为说明文件。...到上一步Doxygen已经完全配置好,可以Run中点击运行了,但为了保存以上配置信息,可以将配置好文件存一个.cfg文件,之后再运行Doxygen时只需要将该文件Doxygen打开,改变第(1)步输入...10.Run->Run Doxygen  即可运行Doxygen,运行完成后输出目录html文件夹中找到index.chm文件即为输入代码文档说明。...3.先从文件开始注释,然后是所在文件全局函数、结构体、枚举变量、命名空间→命名空间中类→成员函数和成员变量。 4.Doxygen无法为DLL定义类导出文档。...它被设计为实现一个“lazy”group定义方法:可以.h文件中使用高优先级来定义结构,.cpp文件中使用\weakgroup这样不会重复.h文件层次结构。

    4.4K30

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

    启动一个干净项目的努力是巨大,但不用担心——很快就会得到回报。 我们将遍历所有文件,并详细查看它们做什么以及它们项目中作用。这将在四个步骤完成:构建、测试、安装和提供文档。...然后我们提供了一个AddTests,该将准备一个测试目标、启用覆盖和内存检查。让我们详细看看它是如何工作。 准备覆盖模块 为多个目标添加覆盖是一个有点棘手过程,因为它包括几个步骤。...我们来看看它是如何使用。 应用测试场景 为了测试工作,必须发生几件事情: 我们需要为两个目录创建嵌套列表文件并定义测试目标。 单元测试需要编写并作为可执行目标准备。...安装和打包 我们回到前一章讨论主题,并从快速查看设置安装和打包所需文件开始: ![Figure 12.6 – 配置安装和打包文件示例 这里只需要文件——大部分工作已经之前章节完成。...它分为两个类别: 技术文档(接口、设计、类和文件) 一般文档(其他不如此技术性文档) 正如我们第十章中看到,生成文档,很多技术文档可以通过使用 Doxygen CMake 自动生成

    14500

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

    for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 文件总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...结构/枚举必须遵循doxygen文档语法 声明结构体时,它可以使用以下三种不同选项之一:   1....< Blue color */ } point_color_t; 函数文档必须在函数实现编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...(x) : (y)) 10 头/源文件 ---- 文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file....c文件 .c文件应该首先包含相应.h文件,然后是其他文件,除非另有明确必要 文件不包含模块私有声明 头文件示例(示例没有license) /* License comes here */

    1.8K20

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

    for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 文件总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...结构/枚举必须遵循doxygen文档语法 声明结构体时,它可以使用以下三种不同选项之一:   1....< Blue color */ } point_color_t; 函数文档必须在函数实现编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...(x) : (y)) 10 头/源文件 文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file....c文件 .c文件应该首先包含相应.h文件,然后是其他文件,除非另有明确必要 文件不包含模块私有声明 头文件示例(示例没有license) /* License comes here */

    2.5K20

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

    for negative check */ 对于注释,总是使用/* comment */,即使是单行注释 文件总是包含带有extern关键字c++检查 每个函数都必须包含doxygen-enabled...结构/枚举必须遵循doxygen文档语法 声明结构体时,它可以使用以下三种不同选项之一: 1....< Blue color */ } point_color_t; 函数文档必须在函数实现编写(通常是源文件) 函数必须包括简要和所有参数文档 如果每个参数分别为in或out输入和输出,则必须注意...(x) : (y)) 10 头/源文件 ---- 文件末尾留下一个空行 每个文件都必须包括文件doxygen注释和后跟空行简要描述(使用doxygen时) /** * \file....c文件 .c文件应该首先包含相应.h文件,然后是其他文件,除非另有明确必要 文件不包含模块私有声明 头文件示例(示例没有license) /* License comes here */

    1.2K40

    【Tip】如何引用dll随附xml注释文档、pdb调试库等文件不出现在项目输出目录

    其中xml是同名dll注释文档,pdb是调试库。我们最终应该只想要exe和dll,除了手工删,我知道有两招,可以项目生成后,xml和pdb不会出现: 1、利用项目【生成事件】。...项目\属性中有个生成事件,分事前、事后两个事件,于是可以事后事件写上删除语句。...我猜测web项目的发布动作并不是先生成本地bin,完了再拷过去,而是有可能先生成一个临时目录,完了再从临时目录分别拷到bin和远端,所以只删bin无济于事,关键是删临时目录,我猜测是obj目录,...allowedextension就是允许包含文件类型,比如.pdb就代表允许包含pdb文件,那么bin中就可能会出现pdb。...需要说明,项目自身pdb和xml是否生成,正确是【项目\属性\生成】中进行设置。生成事件法可以作用到项目自身相关文件,但Allow...元素法不会,它只对所引用程序集相关文件有效。 -文毕-

    1.6K30

    Ubuntu12.04下使用doxygen生成API文档

    前段时间公司里做项目要求遵循doxygen文档规范,并且Windows XP下安装了Doxygen 1.8.4版本,使用起来能查看文件是否遵循doxygen规范和一些简单错误,另外还可以根据...、Ubuntu12.04下使用doxygen将下载好源代码生成API文档。...3、配置dbus工程选项,例如:doxygen脚本配置文件存放路径、doxygen API文档存放路径、工程名、版本号等信息。...工作目录,例如/home/ccf/Downloads下创建tmp目录存放doxygen脚本配置文件,创建dbus-html-docs目录用于存放输出dbus API文档,另外将解压缩后dbus-1.6.10...5、查看生成 dbus API文档参考手册, 可以直接单击第4步Run doxygen Tab页【Show HTML output】按钮,查看dbus API html格式文档

    1.5K30

    JavaScriptwindow.load小记

    load事件通常用于检测文档内容或者图片是否加载完毕。 本文着重介绍注册window对象上load事件,也就是window.onload事件。...网页某些JavaScript脚本代码往往需要在文档加载完成后才能够去执行,否则可能导致无法获取对象情况,为了避免类似情况发生,可以使用以下两种方式: (1).将脚本代码放在网页底端,运行脚本代码时候...window.onload是一个事件,当文档内容完全加载完成会触发该事件。可以为此事件注册事件处理函数,并将要执行脚本代码放在事件处理函数,于是就可以避免获取不到对象情况。..."; } 代码完成将div背景颜色设置为#F90,将设置背景颜色代码放置window.onload...事件处理函数,当文档加载完成后,才会执行事件处理函数,保证文档已经加载完成。

    58710

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

    首先,关于VA助手破解安装教程,请参考:VS2015 Visual Assist X 破解版安装教程 此处分享一下我工程中使用VA助手进行快速注释小技巧,感兴趣小伙伴可以借鉴下。...第七步:对枚举类型(enum)注释模板,见图8. ? /// @enum DB_TYPE??? /// @brief 数据库类型??? 第八步:对类型(macro)注释模板,见图9. ?.../// @brief 导出符号定义 用法:简单举个例子,比如我们对于filter_t.h文件想给出注释,我们只要在VS, 输入「//Header」,即可得到如下注释行。...修改下上面的函数功能,写上你对这个函数功能具体注释即可。 那么,我们为什么要进行按照doxygen注释规范来进行注释呢,这样做有什么好处呢?...我们可以使用上述注释,快速生成如下图所示库说明文档。 ? 至于doxygen具体使用方法,已经【3D视觉工坊】知识星球给出了介绍,如果愿意学习了解同学,可以前往查看

    3.8K20

    Objective-C处理器指令与

    引 什么是预处理器,跟我有什么关系? 预处理器OC源文件编译过程一个部分,而且是第一个处理部分,预处理器也由此可见。...发生错误后,会抛出说"文件名"文件第11行有错误。后面跟着文件名是一个可选项,写了就可以消息显示,不写也没关系。...UITableView Delegate …… 这个#pragma mark指令可以Xcode 文件方法列表插入标记,#pragma mark -就可以插入一个分隔线,后跟文字就可以插入文字标签...除此之外,#pragma指令还包含很多别的选项,上面的是用最多,其他可以查看文档。...结 以上就是OC编译处理器一些预处理语言函数内容,预处理器内容当然不单单只有这些,还有对源文件一些处理,但这些是我们平常开发中经常遇到,了解他们是必须且重要查看作者首页

    71030

    利用Doxygen生成代码文档

    Doxygen是一个代码文档生成工具。它从代码文件中提取注释并可生成多种文档形式。如:网页文档HTML,RTF (MS-Word),PDF等等。同时也可生成函数之间调用和文件依赖关系图表。...如果需要生成chm文件,可将doxygen生成网页文件拷贝至windows环境下,然后用htmlhelp来生成chm文件。 注释和文档效果 头文件添加如下函数注释。...其实还有其他风格。可以查看下面的网址了解: https://www.doxygen.nl/manual/docblocks.html#cppblock 文档对应显示效果如下。...A more elaborate class description. */ 如果希望生成文档包含源码,则需要如下配置 图片 生成文档 具有Doxyfile配置文件目录下运行doxygen即可生成文档...doxygen 也可以doxywizard里点击运行doxygen来生成文档。 图片

    1.7K40

    我为什么建议你这样写注释

    摘要 本文档主要用来指导和建议工程师如何写好软件代码注释,方便使用Doxygen生成文档 2. 准备工作 安装Doxygen软件 正常代码工程 3....Doxygen就是开发中广发使用工具,如果你留意的话,很多源码包都是使用Doxygen来生成代码文档,如下图就是我使用Doxygen为工程生成文档一个文件展示 ? ? ?...而生成这样文档,注释就要按照Doxygen规则,注释就要按照类似如下格式来书写 ?...如果你记不住没关系,,可以多翻阅,这些规则都有例子,或者参阅一些源码包注释,如我们来看一些源码包注释风格: 如lwip 协议栈源码包就是按照doxygen来注释,只要运行相应文件就可以生成文档...可以看到注释风格就是Doxygen 要求。同样在其他一些常用源码包里,大部分都是使用了doxygen来生成相应文档。这样整个项目的结构和接口都会生成一个详细文档,可以支持不同格式。

    67320

    【工具】这个神器可以提取你代码关键信息生成技术文档

    这里覆盖了C语言标准库所有函数,给出了每个函数介绍并且都给出了具体用法示例,比如: ? ? 只不过都是英文说明,可见英文重要性。...另一种方法是,找一些离线文档,网上有不少人整理了一些离线文档,比如.chm格式(已编译帮助文件文档: ? 里面大概是这样子: ?...其中doxygen是一种开源跨平台文档系统,doxygen可以从一套归档源文件开始,生成HTML格式在线类浏览器,或离线LATEX、RTF参考手册。...doxygen可以生成好几种格式文档,要生成.chm格式手册就必须安装htmlhelp,要生成关系图必须安装依graphviz。...(6)设置一些构建选择项 ? (7)设置输入文件编码 ? (8)设置是否.chm中生成源码以供预览 ? (9)设置HTML选项 ? (10)设置Dot选项 ? ?

    1.7K20

    回顾 | Facebook开源产业级深度学习框架 Caffe2

    模型库 Caffe2 Model Zoo 里面的训练模型,只需几行代码就能运行。...更新信息可以查看 Caffe2 文档和教程请访问 caffe2.ai,并查看 GitHub 源代码。(下文有介绍。)...某些情况下,你可能希望使用现有的模型,跳过整个“学习”步骤,尝试训练你自己模型之前,就熟悉深度学习是如何实用和有效。 Caffe2 API:C++ & Python ?...在教程方面,有模型和数据库介绍,从 Caffe2 基本讲起,包括 Workspaces、Operators & Nets,还有 Toy Regression、图像预处理、加载训练模型、MNIST(...我们不可能让人随身携带超级计算机,那么, AI 在当前最为普及便携设备——智能手机工作上工作就成为关键一环。

    85070

    文档代码同源

    我们思路就是,利用Doxygen工具,将代码和文档开发变为同步过程。由于文档含在代码里,也意味着Doxygen文档也是文本,版本库管理下,能精确看到每一个比特修改。...(后面有文章做一个Doxygen介绍。)这里简单介绍一下DoxygenDoxygen 是一个程序文档产生工具,可将程序特定注释转换成为说明文件。比如说对于以下这段注释: ?...这是我们实现文档代码同源基础。但文档代码同源不仅仅是把代码和文档合成一个源代码文件。...Doxygen支持自由页面,可以写一个Python小工具,将excel需求表转化为 txt文本文件,被doxygen所识别。 ? ?...无论怎么更改,只要每天保证文档、代码对应。下载最新源代码,使用Doxygen编译,则可得到最新文档。 3、补充说明 文档代码同源思路,可解决实践文档代码不一致问题,但这不是最终目的。

    51540

    【重磅】Facebook 开源产业级深度学习框架 Caffe2,带来跨平台机器学习工具

    模型库 Caffe2 Model Zoo 里面的训练模型,只需几行代码就能运行。...更新信息可以查看 Caffe2 文档和教程请访问 caffe2.ai,并查看 GitHub 源代码。(下文有介绍。)...某些情况下,你可能希望使用现有的模型,跳过整个“学习”步骤,尝试训练你自己模型之前,就熟悉深度学习是如何实用和有效。 Caffe2 API:C++ & Python ?...在教程方面,有模型和数据库介绍,从 Caffe2 基本讲起,包括 Workspaces、Operators & Nets,还有 Toy Regression、图像预处理、加载训练模型、MNIST(...我们不可能让人随身携带超级计算机,那么, AI 在当前最为普及便携设备——智能手机工作上工作就成为关键一环。

    79670
    领券