Whole Tomato Software Forums
Whole Tomato Software Forums
Main Site | Profile | Register | Active Topics | Members | Search | FAQ
User name:
Password:
Save Password
Forgot your password?

 All Forums
 Visual Assist
 Technical Support
 VA 2393: Document Method not checking existing
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

Uniwares
Tomato Guru

Portugal
2047 Posts

Posted - Nov 13 2020 :  10:09:56 AM  Show Profile  Reply with Quote
When invoking "Document Method", it doesn't check if an documentation header already exists or not, it just inserts a(nother) whole documentation header.
Would be great if VA would offer to complete documentation (in case parameters or tags are missing), or just dont offer it.

feline
Whole Tomato Software

United Kingdom
17027 Posts

Posted - Nov 14 2020 :  11:17:29 AM  Show Profile  Reply with Quote
The idea of updating an existing comment block from Document Method with new parameters did come up once before:

case=6535

are you thinking of just adding extra parameters? Adding all parameters if VA doesn't detect parameter information in the comment block? In C#, if we assume XML comments then working out which parameters are commented is probably straight forward, but in C++ with much more random and unstructured comments, it becomes quite a bit harder.

zen is the art of being at one with the two'ness
Go to Top of Page

Uniwares
Tomato Guru

Portugal
2047 Posts

Posted - Nov 16 2020 :  09:31:11 AM  Show Profile  Reply with Quote
For now, I'd be happy with C# support and structured XML comments. The IDE now actually offers to add missing parameter documentation if there is partial documentation (with sandcastle installed it seems), so maybe just checking for existing doc is already fine?
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
17027 Posts

Posted - Nov 16 2020 :  1:51:17 PM  Show Profile  Reply with Quote
That makes sense, I have put a note onto the case about this. Structured XML comments are a reasonable case to handle.

zen is the art of being at one with the two'ness
Go to Top of Page
  Previous Topic Topic Next Topic  
 New Topic  Reply to Topic
 Printer Friendly
Jump To:
© 2019 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000