New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Procedure description attribute #54

Open
retailcoder opened this Issue Nov 19, 2014 · 4 comments

Comments

Projects
None yet
3 participants
@retailcoder
Member

retailcoder commented Nov 19, 2014

This feature allows the user to enter a short description for a module member, to appear in the object browser when it is selected.

related: #48 & #49 (same prerequesites, although like #52 it can work off temporary files)

@retailcoder retailcoder added this to the Module & Procedure Attributes milestone Nov 19, 2014

@rubberduck203 rubberduck203 modified the milestone: Module & Procedure Attributes Feb 10, 2015

@retailcoder retailcoder added this to the Future Versions milestone Feb 10, 2015

@retailcoder

This comment has been minimized.

Show comment
Hide comment
@retailcoder

retailcoder Sep 22, 2015

Member

Again (sorry for all the notifications!), @ckuhn203 is the SCI code responsible for exporting/importing modules decoupled enough to be reused for this?

Member

retailcoder commented Sep 22, 2015

Again (sorry for all the notifications!), @ckuhn203 is the SCI code responsible for exporting/importing modules decoupled enough to be reused for this?

@rubberduck203

This comment has been minimized.

Show comment
Hide comment
@rubberduck203

rubberduck203 Sep 22, 2015

Member

Yes. Absolutely. It's implemented through VBE extensions. IIRC it's even located in the VBE project.

Member

rubberduck203 commented Sep 22, 2015

Yes. Absolutely. It's implemented through VBE extensions. IIRC it's even located in the VBE project.

@retailcoder

This comment has been minimized.

Show comment
Hide comment
@retailcoder

retailcoder Mar 18, 2016

Member

As of yesterday, we're reading these attributes into Declaration objects. I feel like delaying writing to 2.x, there's really quite a bit of work left to do with the other core things.

Member

retailcoder commented Mar 18, 2016

As of yesterday, we're reading these attributes into Declaration objects. I feel like delaying writing to 2.x, there's really quite a bit of work left to do with the other core things.

@retailcoder

This comment has been minimized.

Show comment
Hide comment
@retailcoder

retailcoder Mar 13, 2017

Member

Per linked issue, this will be implemented as annotations:

'@ModuleAttribute.VB_Description("This module is responsible for XYZ")
'@MemberAttribute.VB_Description("This procedure is responsible for XYZ")

Or:

'@Description("This module is responsible for XYZ")

The @Description annotation would be context-sensitive and become a module attribute when found in the declarations section, or a member attribute when found in a procedure.

This annotation will require an inspection to ensure only one attribute is created per scope.

Member

retailcoder commented Mar 13, 2017

Per linked issue, this will be implemented as annotations:

'@ModuleAttribute.VB_Description("This module is responsible for XYZ")
'@MemberAttribute.VB_Description("This procedure is responsible for XYZ")

Or:

'@Description("This module is responsible for XYZ")

The @Description annotation would be context-sensitive and become a module attribute when found in the declarations section, or a member attribute when found in a procedure.

This annotation will require an inspection to ensure only one attribute is created per scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment