<note> XML comment flagged

I have C# code that uses the <note> XML comment which is recognized by NDoc and SandCastle.

The problem is that R# flags this twice.  Once for <note> and once for </note>.

I know about Tools/To-do Items and see that I can delete flagging of Note but I do not want to do that.

Has anyone figure out what the regular expression should be?

By default, I think that R# should ignore these.

3 comments
Comment actions Permalink

It should be as simple as this regex is note:\s+.+ or you want any variation of note to show up in the To-do explorer ?

0
Comment actions Permalink

I'd like for R# to continue to do everything it does out of the box, except that it should ignore XML comments which use the note element.

This is existing regular expression for Note:

(\W|^)(?<TAG>NOTE)(\W|$)(.*)

Here is the syntax for <note> in NDoc (Sandcastle is the same):

http://ndoc.sourceforge.net/usersguide.html

Here is an example (notice how R# flags this in the text by changing the color to blue):


/// <note type="caution">


/// Both <seealso cref="BaseUri"/> and <seealso cref="WebRequestTemplate"/>


/// must be set prior to calling any document management functions.


/// </note>

0
Comment actions Permalink

One thing you can do is to make it case-sensitive, alternatively you can use this regex ^NOTE.+$

0

Please sign in to leave a comment.