Doxygen - 将参数声明为可选

2023-12-22

我正在使用 Doxygen 记录代码库,并且想知道是否有一个关键字用于将函数的参数声明为可选。就像是:

/*!
\fn int add(int a, int b=0)
\brief adds two values
\param a the first operand
\param \optional b the second operand.  Default is 0
\return the result
*/

似乎这是应该存在的东西,但我一直无法在任何地方找到它。有实际的选择吗,还是我只需要在描述中注明?


回答你的问题:不,没有这样的事情。

但我不同意你认为应该有类似的东西的观点。毕竟,函数声明将与其文档一起显示,因此每个人都可以看到b是可选的,它的默认参数是什么。而对于\fn请参阅 doxygen 的文档不鼓励使用 \fn http://www.doxygen.nl/manual/commands.html#cmdfn.

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Doxygen - 将参数声明为可选 的相关文章

  • minidump stackwalk 与 gdb 回溯

    我的 Firefox 中有一个漏洞触发器 CVE 2018 18492 它会崩溃并给出 SIGSEGV 我用过breakpadminidump stackwalk从崩溃时生成的小型转储文件中获取其堆栈跟踪 我得到如下内容 Thread 0
  • 处理长时间运行的报告

    我正在开发一个用 C 和 Sql Server 2000 数据库编写的 ASP net 应用程序 我们有多个 PDF 报告供客户用于满足其业务需求 问题是这些报告需要一段时间才能生成 gt 3 分钟 通常最终发生的情况是 当用户请求报告时
  • 将不同的单词保存到链接列表中

    基本上我这里有两个链接列表 列表和不同的 有几组单词之前已保存到 列表 结构中 我要编写一个程序 它会找到不同 唯一的单词并将其保存到 不同 结构中 这是我到目前为止根据我的指针概念得到的结果 然而 当我尝试打印 distinct 时 程序
  • 将 IRandomAccessStreamWithContentType 转换为 Byte[]

    在我的应用程序中 我允许用户使用 ContactPicker 添加联系人 我尝试将 IRandomAccessStreamWithContentType 转换为 Byte IRandomAccessStreamWithContentType
  • ASP.NET Identity Extend 方法来访问用户属性

    我可以扩展方法来访问用户属性吗 有这样的方法 User Identity GetUserId User Identity GetUserName 可以从视图和控制器访问它们 我想使用以下方法扩展此功能 User Identity GetUs
  • 在 VB.NET 中将类标记为静态

    正如刚刚在最近的一篇文章中所说question https stackoverflow com questions 135759 why cant i inherit iodirectory and answer https stackov
  • 为什么 std::move() 没有窃取 int 值? [复制]

    这个问题在这里已经有答案了 std move 正在窃取字符串值 而不是 int 请帮助我 int main int i 50 string str Mahesh int j std move i string name std move s
  • 将委托作为方法参数传递

    我目前正在开发一个 EventManager 类 以确保没有任何事件连接到失效的 WCF 双工客户端 并控制防止从同一客户端到一个事件的多个连接 现在基本上 我所坚持的就是尝试将事件委托传递给一个函数来控制这样的分配 var handler
  • 虚拟调用与类型检查的另一个例子

    Problem 我发誓 每次我脑子里都在想 我应该使用虚拟调用而不是类型检查 例如 if obj is Foo else if obj is Bar 我想出了另一个例子 我不知道如何实现前者 我正在通过串行端口实现分组协议 一些伪代码可以最
  • Promise.defer 的正确模式是什么?

    我正在使用 TypeScript 和async await来表示异步工作流程 该工作流程的一部分是调用 Web Worker 并在其回调结果时继续 在 C 中 我会创建一个TaskCompletionSource await its Tas
  • 检查 ASP.NET Web 应用程序在运行时是否处于调试模式的首选方法?

    在编译时我可以做这样的检查 if DEBUG Log something endif 但最好检查一下是否debug false 是在运行时在 Web config 中设置的吗 HttpContext IsDebuggingEnabled h
  • 如何使用 MonoTouch c# 以编程方式获取联系人?

    如何获取 iPhone 中的联系人 我需要从 iPhone 联系人中获取所有属性 如何使用MonoTouch以编程方式实现 ABAddressBook iPhoneAddressBook new ABAddressBook ABPerson
  • 如何获取结构数据的十六进制转储

    finalize char hdrs sendip data headers int index sendip data data sendip data pack 出于调试目的 我想要一个十六进制转储data and pack结构体 其类
  • 为什么检查 SynchronizationContext 是否为 null?

    InstallIfNeed方法 http referencesource microsoft com System Windows Forms winforms Managed System WinForms WindowsFormsSyn
  • 添加 Imap 文件夹 Mailkit

    我尝试使用 Mailkit 添加顶级文件夹 因此当我添加以下标签时 我可以将它们分组到该文件夹 下 标签是 邮件包 档案 邮件包 标记 我想创建一个名为 mailkit 的文件夹 以便 gmail 将它们分组 但目前我似乎无法找到执行此操作
  • 检查对象的每个属性是否为空

    我的课程具有多个属性 public class Employee public string TYPE get set public int SOURCE ID get set public string FIRST NAME get se
  • 如何可靠地判断 boost 线程是否已退出其 run 方法?

    我以为 joinable 会表明这一点 但事实似乎并非如此 在工人阶级中 我试图表明它仍在通过谓词进行处理 bool isRunning return thread gt joinable 已经退出的线程不是不能加入吗 我错过了什么 boo
  • 带有 Null 的 Soap WSDL

    我需要在函数中指定一个可为空的参数 这不起作用
  • 如何安装 C++ 的 VOCE?

    我正在尝试安装 VOCE api 它是为 C 和 Java 构建的语音识别 API 这是我第二次使用外部 C 库 也是第一次使用 Java C api 语音链接 http voce sourceforge net http voce sou
  • Outlook VSTO 添加上下文菜单项

    我正在尝试将菜单项添加到附件上下文菜单 问题是该项目没有显示 我看过一些例子 他们说这段代码应该可以工作 this Application AttachmentContextMenuDisplay new ApplicationEvents

随机推荐

  • 检查 INTENT 互联网连接

    有安卓的吗Intent ACTION XXX当互联网连接可用时通知我 我想实例化一个BroadcastReceiver当用户启用互联网连接 通过 wifi GSM 等 时通知我的应用程序 有人可以帮助我吗
  • 我如何知道我正在使用什么 CLR?

    是否有信息可以告诉我正在使用的 NET 版本以及它是否是 NET 2 0 SP1 Thanks 您可以使用Environment Version http msdn microsoft com en us library system en
  • 如何使用 Vaadin CDI 和 Navigator 实现 MVP?

    我想使用 Vaadin 在我的 Web 应用程序中实现 MVP 模式 我正在使用 Vaadin Navigator 和 CDIViewProvider 如下所示 MyUI java public class MyUI extends UI
  • 如何在 Linux 中重新定义 malloc() 以在 C++ new 中使用

    我为我定义了 mem malloc 和 mem free 我想用它们来替换 malloc 和 free 以及 C 的 new 和 delete 我将它们定义如下 extern C extern void mem malloc size t
  • 将 s3 上的多个 zip 文件合并为更少的 zip 文件

    我们遇到一个问题 其中 s3 目录中的某些文件的大小约为 500MiB 但许多其他文件的大小为 KiB 和字节 我想将所有小文件合并成更少的大约 500MiB 的大文件 在 s3 文件夹中重写数据的最有效方法是什么 而不必下载 在本地合并并
  • 如何获取 ADF2 中动态内容中一个月的最后一天?

    我想根据 utcnow 时间戳获取一个月的最后一天 下面表达式中的 dd 应该自动为该月的最后一天 28 30 或 31 formatDateTime adddays utcnow 2 yyyy MM ddT23 59 59 999 考虑到
  • 如何使用 CNContactPickerViewController 使用一组电话号码来过滤联系人?

    我尝试使用一组现有电话号码从地址簿中过滤一些联系人 CNContactPickerViewController当这些联系人的电话号码与现有电话号码匹配时 应禁止选择这些联系人 我需要使用电话号码作为过滤器 因为这些电话号码可能来自其他应用程
  • 如何从使用ajax的javascript函数获取值

    我正在调用一个使用 ajax 获取值的函数 如何将该值返回给调用函数 我的ajax调用函数是 function getStatusOfAdv advID ajax url baseURL admin advertisers get adv
  • 如何在 GWT RichTextArea 中设置光标位置

    有没有办法在 GWT RichTextArea 中设置 cusror 位置 在 TextArea 中有 setCusrorPosition 方法可以执行此操作 但在 RichTextArea 中则没有 也许有一个本机 JavaScript
  • 具有多个可执行文件的应用程序显示已签名,但会触发防火墙警告

    我正在为 OS X 开发一个使用多个可执行文件的 QT 应用程序 我们通过签署 app 中的每个可执行文件来签署 app 然后使用 f 选项签署整个 app 这是我们联系 Apple 时建议的程序 但是 每次我们的应用程序启动时 都会向用户
  • 切换打印机托盘

    我知道这个问题以前曾被问过 但没有明确的答案 如何以编程方式更改打印机纸盒 我正在尝试使用 python 批量打印一些 PDF 我需要从不同的纸盘打印不同的页面 打印机是理光2232C 有没有办法通过 Acrobat Reader 命令行参
  • Postgres 约束确保多列中的一列存在?

    有哪些好方法可以向 PostgreSQL 添加约束以检查恰好有一个列 来自一组列 包含非空值 Update 我可能想使用check表达式详见创建表 http www postgresql org docs 9 2 static sql al
  • SQL 递归菜单排序

    我有一个简单的表格 用于表示类别的层次结构 CREATE TABLE dbo Categories ID int IDENTITY 1 1 NOT NULL Title varchar 256 NOT NULL ParentID int N
  • 拒绝连接到 [url],因为它违反了以下内容安全策略指令

    我是 Chrome 扩展程序的作者 该扩展程序允许直接在 Facebook 上翻译状态更新和评论 https chrome google com webstore detail facebook translate plofenifjagm
  • 如何检测用户何时处于最大缩放级别? (谷歌地图v3)

    我正在将我的标记聚集在一起 当用户放大到最高级别时 我需要分解集群 以便用户可以查看各个项目的信息 鉴于缩放级别的数量根据所使用的地图类型而不同 并且 maxZoom 可能已在mapOptions中明确设置 我如何检测用户何时无法进一步缩放
  • 获取所有 css 类的背景和颜色属性值

    我想获取所有 CSS 声明的所有背景和颜色属性值 例如 body background fff aaa background dedede color 000 text color 333 padding 10px 我想要得到这样的输出 并
  • 在javaFX中对canvas的一部分进行快照

    我需要将画布的某些部分保存到来自的图像x1 gt 0 and y1 gt 0对某些人x2 gt x1 and y2 gt y1 据我从javaFX API的理解 快照必须占据节点的整个区域 就像 wim new WritableImage
  • MySQL RDS 和 JDBC SSL 连接出现错误:无法找到请求目标的有效证书路径

    我正在尝试在 JDBC 和 AWS RDS 之间建立 SSL 连接 在这里 我使用以下命令创建了一个密钥库 convert certificate into java understandable format openssl x509 o
  • HTML 母版页

    有没有办法在纯 HTML 中创建与 ASP NET 中的主页面 内容页面类似的想法 我想用 HTML 创建多个页面 但我希望所有页面看起来都相同 但有些内容不同 有没有办法在不创建多个彼此非常相似的页面的情况下做到这一点 wait unti
  • Doxygen - 将参数声明为可选

    我正在使用 Doxygen 记录代码库 并且想知道是否有一个关键字用于将函数的参数声明为可选 就像是 fn int add int a int b 0 brief adds two values param a the first oper