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 - 将参数声明为可选 的相关文章

  • 自动映射器多对一映射

    我想将一种类型映射到另一种类型 但我在第一种类型中有多个属性 需要获取其他类型的一个属性 例如 public class A public int a get set public int b get set public int c ge
  • Hololens 应用程序将不再构建 - 引用元数据文件丢失且找不到 c-Sharp.firstpass

    我已按照 Microsoft 在其多个项目下列出的确切步骤进行操作微软全息 学院 https developer microsoft com en us windows holographic academy教程 我完成了所有这些 并且从创
  • 如何在 ASP.Net Core 6 Web Api 中依赖注入 Microsoft Graph 客户端

    我正在尝试使用 ASP Net Core 6 设置 Web api 以便用户可以到达我的端点 然后我使用特权帐户在 Teams 中执行一些工作 我认为我没有正确连接 DI 部分 因为在向 Teams 发出请求时出现以下错误 MsalUiRe
  • 在 TPL Dataflow 中,是否可以在创建块之后但使用之前更改 DataflowBlockOptions?

    有效果吗 我想推迟设置 ExecutionDataflowBlockOptions SingleProducerConstrained 属性 直到我准备好将网络链接在一起 因为 我想将创建块及其语义与将网络及其语义链接在一起分开 但据我所知
  • 不要覆盖 Azure Blob 存储

    我有一种将文件添加到 Azure Blob 存储的方法 问题是我试图指定一个条件 在该条件下它不会覆盖 blob 而只是添加到其中 我正在尝试使用参数访问条件 但是 VS 说这个方法不能采用两个参数 async void archiveNe
  • 有什么办法可以让这个 C# 代码更快吗? [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我正在读取一个大文件 X12 并解析其中的信息 我有两个瓶颈功能 我似乎无法解决 read line 和 get element 有什
  • 改进绩效反思 - 我应该考虑哪些替代方案?

    我需要动态地设置对象上的一堆或属性的值 将其称为传输对象 将在短时间内创建相当数量的此类传输对象并设置其属性 我想避免使用反射 还有其他选择吗 如果是的话 有我可以查看的示例实现吗 Use Delegate CreateDelegate h
  • 从 C# 访问 COM vtable

    C 中有没有办法访问 COM 对象的虚拟方法表以获取函数的地址 经过大量搜索和拼凑不同的部分解决方案后 我弄清楚了如何做到这一点 首先 您需要为您尝试访问的对象定义 COM 组件类 ComImport Guid InterfaceType
  • 使用 Rhino Mocks 模拟集合

    所以我猜这是很多人想做的事情 模拟集合 过去我用 Rhino 做过这样的事情 var col mock MockRepository GenerateMock
  • std::istringstream >> 使奇怪的行为加倍

    下面的代码打印0在 mac osx 上使用 clang 其他地方都会打印5 clang https ideone com mVgpzS gcc https ideone com oZ0hy6 include
  • 如何转换 UTF-8 <-> UTF16 可移植

    有没有一种简单 可移植的方法 至少是 win32 linux 将 UTF 16 转换为 UTF 8 并返回 最好使用升压 谢谢你的帮助 托比亚斯 Both libiconv http www gnu org software libicon
  • 如何将8字节的十六进制数输入到char数组中?

    我想生成以以下开头的十六进制数字序列07060504003020100 下一个数字是0f0e0d0c0b0a0908等等按这个顺序 当我使用unsigned long long int并输出数据的前4位 这意味着0被截断 它打印706050
  • 检查字符串中是否存在所有字符值

    我目前正在做这项任务 但我被困住了 目标是读取文件并查找文件中的字符串中是否存在这些字符值 我必须将文件中的字符串与作为参数放入的另一个字符串进行比较 但是 只要每个字符值位于文件中的字符串中 那么它就 匹配 示例 输入和输出 a out
  • 更改为通用接口对性能的影响

    我使用 Visual Studio 使用 C NET 开发应用程序 ReSharper 在我的方法原型中经常建议我用更通用的类型替换输入参数的类型 例如 如果我仅在方法主体中使用带有 foreach 的列表 则使用 List 和 IEnum
  • 在另一个类中使用一个类对象?

    我正在用 c 制作应用程序 在该应用程序中 我有一个类DataCapture cs 在同一个应用程序中 我有另一个类Listner cs 在 Listner cs 类中 我想使用以下对象DataCapture cs不创建新对象DataCap
  • 在 Windows 上构建 MLT 框架时出错

    我一直在遵循官方提供的构建指南here http www mltframework org bin view MLT WindowsBuild 我需要 MLT 来创建视频播放器 并且我选择仅安装前 4 个库 如指南中所述 FFmpeg SD
  • 我们可以向 ServicePointManager.SecurityProtocol 添加四个协议吗?

    我想支持从 ssl3 到 tls 1 2 的所有安全协议 但是在网上搜索时我发现代码为 ServicePointManager SecurityProtocol SecurityProtocolType Ssl3 SecurityProto
  • 如何同时正确使用管道和信号?

    我有 2 个孩子 我想将信号从孩子发送到父母 并将答案 随机数 为什么 为什么不 命名管道从父母发送到每个孩子 我有这个代码 include
  • 您可以从 AuthorizeAttribute 返回 HTTP 响应而不引发异常吗?

    我在各种控制器上使用 AuthorizeAttribute 可能需要根据请求本身的某些属性返回 403 或 429 请求过多 我完全在自定义 OnAuthorization 实现中实现了它 然后在必要时抛出一个带有适当响应代码的新 Http
  • 删除指针后将其设为 NULL 是一个好习惯吗?

    我首先要说的是 使用智能指针 您将永远不必担心这个问题 下面的代码有什么问题 Foo p new Foo use p delete p p NULL 这是由答案和评论 https stackoverflow com questions 19

随机推荐

  • 检查 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