主页 / computer / 问题 / 1637890
Accepted
Lluser
Asked: 2021-03-30 04:44:38 +0800 CST

VBA：RubberDuck 插件：@VariableDescription 它是如何工作的？

  • 772

我使用RubberDuck 插件（除其他外）使用@Description（用于 Subs、Function、Properties...）注释我的 VBA 代码，并希望@VariableDescription用于变量。但与@Description使用的表单成员不同，我在代码资源管理器中看不到这些变量描述。

我找到的唯一文档是：@VariableDescription. 我知道这@VariableDescritption适用于其他成员的变量@Description- 它也必须显示在代码资源管理器中。

我错过了什么？它应该如何工作？

PS：我决定将它发布给超级用户而不是堆栈溢出，因为这是与工具相关的问题。如果您认为我的决定是错误的，请将其移至适当的部分并接受我的道歉。

vba microsoft-office

1 个回答

  1. Best Answer

    TL;博士：

    变量描述适用于模块变量，但它们只出现在对象浏览器中- 使变量描述出现在 Rubberduck 的命令栏和代码资源管理器工具窗口中，必须在未来的版本中实现。

    在梦境中，只有一个@Description注解，可用于所有可以描述的事物。然而，在许多边缘情况下，正确地确定注释的范围并将它们关联到它们的注释“目标”被证明是一个挑战，尤其是在正确标记模块的第一个成员时：

    Option Explicit
'@Description "does this belong to the module or the 1st member?
Public Sub DoSomething()
End Sub

    为了消除歧义，描述模块本身@ModuleDescription的模块级注解变为 ，描述模块级变量的模块级注解变为@VariableDescription。

    注释注释本身不会做任何事情，但是一旦 Rubberduck 解析了项目，它就能够将注释注释与模块的隐藏VB_Attribute值进行比较，并且代码检查会在Rubberduck 机会类别下标记不同步的属性/注释。

    同步后，描述字符串将出现在 VBE 的对象浏览器( F2) 中：

    显示描述文本的对象浏览器

    现在，Rubberduck 的代码浏览器也显示这些描述：

    显示模块描述的代码资源管理器

    ...但似乎变量描述没有出现：

    代码资源管理器未显示变量描述

    描述也应该出现在 Rubberduck 的命令栏中：

    显示模块描述的命令栏

    事实上它没有出现在模块变量中......

    命令栏不显示变量描述

    ...告诉我这是一个疏忽，需要修复！

    这应该是一个相对简单的修复，可以随下一个版本一起发布:)

    编辑：此拉取请求中正在修复该错误。

    • 4

相关问题