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
 Spell checking not always working in C# XML docs?
 New Topic  Reply to Topic
 Printer Friendly
Author Previous Topic Topic Next Topic  

KoenTanghe
Senior Member

Belgium
29 Posts

Posted - Mar 01 2017 :  10:45:58 AM  Show Profile  Reply with Quote
Hi,

I'm seeing that spelling mistakes don't always get detected in C# XML docs in Visual Studio 2015 CE.
If I put the same text in Doxygen style comments, then the mistake is detected.
I attached a screenshot of an example from a .cs file:


Note: it's not always failing, as in some cases the spelling mistake IS being detected even if it's in C# XML docs.
I also attached a second screenshot of an example from a .cs file where it does work:


Is this a known bug?
Thanks,
Koen

PS
Long-time Visual Assist user here. Visual Studio itself has come a long way by now, but still considering VA essential (especially for C++ code)! Keep up the good work!

feline
Whole Tomato Software

United Kingdom
19066 Posts

Posted - Mar 01 2017 :  5:04:16 PM  Show Profile  Reply with Quote
That is strange, and unexpected. I am seeing the same problem here though:

case=104095

I have a theory, based on my tests. In the second screen shot, is this the only XML tag in a comment block in the file? For me, spell checking underlining is working, but only if you have one tag pair in the file.

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

KoenTanghe
Senior Member

Belgium
29 Posts

Posted - Mar 03 2017 :  07:37:32 AM  Show Profile  Reply with Quote
Hi feline,

thanks for acknowledging the issue.

And your theory seems plausible:
Indeed in that second example, it was the only XML tag.

Just to test, if I added this for a class method further down in that file:

/// <summary>
/// 
/// </summary>
/// <param name="request"></param>
public override void CreateRequest(CommandRequest request)


the spelling mistake in the original XML docs (from the second screenshot) is not underlined any longer.

To add to this (and what might help your team sorting this out): if I remove the <param name="...."> tag line in that new XML docs statement from above, the spelling mistake does get detected again.
Hope this helps!

Koen
Go to Top of Page

feline
Whole Tomato Software

United Kingdom
19066 Posts

Posted - Mar 03 2017 :  10:04:47 AM  Show Profile  Reply with Quote
Thank you for the update, it is good to have another example of the effect here. I am now not sure quite what the trigger is, since this seems to behaving slightly differently. But clearly there is a problem here. I have updated the bug report with this example.

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:
© 2023 Whole Tomato Software, LLC Go To Top Of Page
Snitz Forums 2000