| T O P I C R E V I E W |
| Uniwares |
Posted - Nov 13 2020 : 10:09:56 AM
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. |
| 3 L A T E S T R E P L I E S (Newest First) |
| feline |
Posted - Nov 16 2020 : 1:51:17 PM
That makes sense, I have put a note onto the case about this. Structured XML comments are a reasonable case to handle. |
| Uniwares |
Posted - Nov 16 2020 : 09:31:11 AM
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? |
| feline |
Posted - Nov 14 2020 : 11:17:29 AM
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. |
