Início / computer / Perguntas / 1637890
Accepted
Lluser
Asked: 2021-03-30 04:44:38 +0800 CST

VBA: Suplemento RubberDuck: @VariableDescription como funciona?

  • 772

Eu uso o suplemento RubberDuck (além de outros) para anotar meu código VBA usando @Description(para Subs, Function, Properties...) e quero usar @VariableDescriptionpara variáveis. Mas, ao contrário dos @Descriptionmembros de formulário usados, não consigo ver essas descrições de variáveis ​​no Code Explorer.

Existe a única documentação que encontrei sobre: @VariableDescription​​. Eu entendo que @VariableDescritptioné para variáveis ​​o que @Descriptioné para outros membros - tem que ser mostrado no Code Explorer também.

O que estou perdendo? Como é suposto funcionar?

PS: Resolvi postar no Super User ao invés do Stack Overflow, pois este é um problema relacionado à ferramenta. Se você considera minha decisão errada, mova-a para a seção apropriada e aceite minhas desculpas.

vba microsoft-office

1 respostas

  1. Best Answer

    TL;DR:

    Variable descriptions work for module variables, but they only appear in the Object Browser - making variable descriptions appear in both Rubberduck's command bar and Code Explorer toolwindow would have to be implemented for a future release.

    In a dream world, there would only have been a @Description annotation, usable for everything that can take a description. However, correctly scoping annotations and associating them to their annotated "target" proved to be a challenge in a number of edge cases, most particularly with properly tagging a module's first member:

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

    Para desambiguar, a anotação em nível de módulo que descreve o próprio módulo se tornou @ModuleDescription, e a anotação em nível de módulo que descreve as variáveis ​​em nível de módulo se tornou @VariableDescription.

    Comentários de anotação não fazem nada sozinhos, mas uma vez que o Rubberduck analisa o projeto, ele é capaz de comparar os comentários de anotação com os VB_Attributevalores ocultos do módulo e as Inspeções de código sinalizam atributos/anotações dessincronizadas na categoria Oportunidades do Rubberduck .

    Uma vez sincronizado, a string de descrição aparece no Object Browser do VBE ( F2):

    Pesquisador de objetos mostrando o texto da descrição

    Agora, o Code Explorer do Rubberduck também exibe estas descrições:

    Code Explorer mostrando a descrição do módulo

    ...mas parece que as descrições das variáveis ​​não aparecem:

    Code Explorer não mostrando a descrição da variável

    As descrições também devem aparecer na barra de comandos do Rubberduck:

    barra de comando mostrando a descrição do módulo

    O fato de não estar aparecendo para uma variável de módulo ...

    barra de comando não mostrando a descrição da variável

    ... me diz que isso foi um descuido e precisa ser corrigido!

    Esta deve ser uma correção relativamente fácil que pode ser enviada com a próxima versão :)

    EDIT: o bug está sendo corrigido neste pull request .

    • 4

relate perguntas