Doxygen 文档
Doxygen 风格的注释可以分布在源代码中,并用于生成各种格式的完整文档。
ReSharper 将 Doxygen 的信息包含在 快速文档 弹出窗口 Control+Q 中:

查看 Doxygen 文档
文档注释中的信息会包含在 快速文档 弹出窗口中,除了类型信息之外。 要调用文档弹出窗口:
将插入符号放在 Doxygen 注释的目标符号处。
按 Control+Q。
如果函数参数与函数描述分开记录,ReSharper 会合并所有注释,并向您显示完整的函数签名文档(与 Doxygen 生成输出时的方式相同)。
创建 Doxygen 注释
要从头创建一个 Doxygen 注释:
输入以下符号之一:
///、//!、/**或/*!,然后按 输入。您将获得一个用于填写文档文本的存根:

您还可以使用 文档实体 (Control+/ )上下文操作。 如果需要,您可以通过 编辑 ReSharper 用于生成的 doc 活动模板来自定义注释存根。
可靠的重命名
在重命名函数或其参数时,需要相应更新文档注释。 在 重命名重构 F2 的情况下,ReSharper 会更新文档注释以及其他引用。
在此之前:

在此之后:

最后修改日期: 2025年 9月 27日