如何让Doxygen解析带__interface关键字的代码

最新推荐文章于 2024-07-07 21:10:32 发布
最新推荐文章于 2024-07-07 21:10:32 发布
阅读量701 收藏
点赞数
分类专栏： C/C++ VS.NET 文章标签： interface preprocessor struct 文档 扩展 微软
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/kongbu0622/article/details/3141584
版权

       微软在VC里添加了很多的关键，比如__interface以方便编写COM组件，但是Doxygen并不认识，所以不会生成文档。但是，Doxygen留下了扩展空间，就是可以支持预处理，这样就可以把__interface进行重定义。

具体做法是，在高级选项里找到Preprocessor，然后设置

ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
PREDEFINED = __interface=struct


就一切OK了

ros2_control 使用教程（一）
weixin_46300916的博客
06-26 2952
包含硬件接口的头文件并添加命名空间定义，以简化进一步开发。实现 on_init 方法。在此，应初始化所有成员变量并处理 info 参数中的参数。在第一行中，通常会调用父代 on_init 来处理标准值，如 name。具体方法是：hardware_interface::(Actuator|Sensor|System)Interface::on_init(info)。
〖ROS2 源码解析〗rclcpp/include/rclcpp/node_interfaces/node_base_interface.hpp
sinat_39783664的博客
08-15 728
ROS2 源码解析：rclcpp/include/rclcpp/node_interfaces/node_base_interface.hpp
Doxygen常用标签命令关键字
achellies's Blog
07-27 2689
Doxygen常用标签命令关键字
Doxygen常用标记（关键字）合集
07-08 3239
一些常用的DoxyGen标记总结归纳成一个合集，方便翻阅快速浏览回忆： 常用标记： @author 作者 @brief 摘要 @version 版本号 @date 日期 @file 文件名，可以默认为空，DoxyGen会自己加 @class 类名 @param 函数参数 @return 函数返回值描述 @exception 函数抛异常描述 @warning 函数使用中
【原】DoxyGen常用标记（关键字）合集
weixin_30700099的博客
07-31 326
最近从Holyn那里得到一个VS2008的宏，添加函数、类注释的时候使用的是DoxyGen的风格，感觉比较好，因此就熟悉了一下DoxyGen常用的标记，便于我对这个宏做“二次加工”。但是我一般用不上DoxyGen，所以就没装使用手册，从网上踅摸了半天，没有一篇文章讲完整的，因此就“自力更生，丰衣足食”吧，把一些常用的DoxyGen标记总结归纳成一个合集，也希望能给其他需要的人带来方便：） 下面是...
Doxygen格式常用关键字
11-18 1144
附件3 Doxygen格式常用关键字表 Doxygen注释关键字（更多内容详见Doxygen手册） 注释命令 标签名 功能描述 特殊功能 \li 生成一个黑心圆. - 生成一个黑心圆. ...
【Intouch_HMI脚本案例深度解析】：实现复杂控制与动态数据处理
![【Intouch_HMI脚本案例深度解析】：实现复杂控制与动态数据处理]...通过实践案例解析，探讨了复杂控制逻辑的实现、动态数据的处理以及与外部系统和设备的集成方法。同时，文中提出了脚本调
接口接口
04-21
6. **源码分析**：标签中的"源码"可能意味着文章深入解析了接口的源代码实现，帮助读者理解底层工作原理。 7. **设计原则**：接口设计遵循一些设计原则，如单一职责原则（SRP）、开放封闭原则（OCP）和依赖倒置原则...
【项目管理】Spring MVC注册登录功能代码组织管理：让项目井井有条的技巧
[【项目管理】Spring MVC注册登录功能代码组织管理：让项目井井有条的技巧](https://javadeveloperzone.com/wp-content/uploads/2017/01/Spring-MVC-Example.jpg) # 摘要 本文详细探讨了Spring MVC框架下注册登录...
doxygen中文手册v1.63.pdf
06-27
文档中以中文详细介绍了Doxygen设置中每个选项的意义，方便了Doxygen软件的使用，而且还包含了注释关键字的使用方法，手动添加书签，很具有参考价值。
doxygen 注释生成工具
09-06
doxygen 是一款免费的文档生成工具, 简洁的关键字和语法， 方便程序员生成在线或离线注释文档
C++ 程序文档生成器介绍(doxygen)
smartkingking的专栏
08-24 2332
http://ly4cn.cnblogs.com/archive/2005/11/23/282637.html   程序文档，曾经是程序员的一个头痛问题。写一个程序文档，比较花时间，但不是很难；麻烦的是当程序修改后，程序文档也要跟着同步更新，否则文档和程序就要脱节，文
doxygen 常用语法
LikeShadow
09-06 1198
1. 头文件 //CommonType.h /** * @file CommonType.h * @brief define common type * @details file details content * @author LikeShadows * @date 2018.09.06 * @version ...
__interface
qq_41786318的博客
08-24 1708
__interface Visual Studio 2015 在原版语言设计中，一个接口类型是用关键字 __interface指明的。在修订版语言中，它被 interface class替代。 Microsoft Specific** A Visual C++ interface can be defined as follows: Can inherit from zero or ...
doxygen的特定命令
weixin_30662011的博客
08-04 429
摘要：本文给出doxygen所支持的全部的一个列表，同时对其进行逐一解释与说明，对于使用doxygen来有重要参考价值。本文主要来自对doxygen官方文档的翻译。 概述 所有在文档中的命令都开始于一个反斜杠(\)或者是一个at-符号(@)。如果你喜欢，可以把所有的以反斜杠开头的命令都换成以at-符号开头的命令。 有些命令有一个或多个参数，每一个参数都其确定的范围： 如果使用 <尖&...
C/C++ 代码注释规范及 doxygen 工具
jucat的博客
07-07 1856
C++ 注释规范及 doxygen 配置和文档生成
c++ 的interface
sinat_39370511的博客
06-17 4978
先要说明的是，c++的关键字中并没有interface，但java和C#中有interface关键字，即接口。interface和class不同，interface仅有接口声明，而且所有的声明默认的访问权限是public而非private（是不是想到了c++中的struct？）。 对于c++来说，这相当于抽象类的概念，即其中的成员函数都是纯虚函数，只有声明，没有实现。如： class abs...
lwip __DOXYGEN__
最新发布
01-17
### 关于 `__DOXYGEN__` 宏在 lwIP 库中的用途 在 lwIP 库中，`__DOXYGEN__` 宏用于条件编译 Doxygen 文档注释。Doxygen 是一种常用的文档生成工具，能够从源代码中的特殊注释提取结构化文档[^1]。 当定义了 `__DOXYGEN__` 宏时，某些特定的代码片段会被包含进来以便更好地支持自动生成 API 参考手册和其他技术文档。这些额外的信息通常不会影响实际运行时的行为，仅作为开发人员编写高质量文档的支持手段。 #### 使用示例 下面是一个简单的例子展示了如何利用这个宏来控制是否显示详细的函数描述： ```c /** * @brief Initialize the network interface. * * This function initializes a given network interface with provided parameters. */ void netif_init(struct netif *netif); #ifdef __DOXYGEN__ /** * @details More detailed explanation about initialization process including parameter validation and resource allocation steps that occur during this call. */ #endif /* __DOXYGEN__ */ void netif_init(struct netif *netif) { // Implementation details... } ``` 通过这种方式，在生成 HTML 或其他格式的技术文档时可以提供更详尽的帮助信息给读者；而在正常的编译过程中则忽略掉这部分冗余的内容以保持二进制体积最小化。 对于那些希望深入了解底层实现机制的人来说，这样的做法既不影响程序性能又能满足他们获取更多信息的需求。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值