Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

What does "///<exclude/>" mean?

I have inherited a bunch of C# code. For a couple of method definitions I find ///<exclude/> as the only XMLDoc in front of it. I tried to Google the meaning of that but was not successful. Can someone please explain what that might mean?

like image 627
Andreas Avatar asked Oct 29 '13 08:10

Andreas


People also ask

What is an example of exclude?

Exclude is defined as to keep out or to refuse to admit. An example of exclude is for a group of children to tell another child that he cannot play with them. To expel; to put out. To exclude young animals from the womb or from eggs.

Does exclude mean remove?

Exclude means to leave out — like when the cool kids won't let you in on their game of four-square or the pizza guy leaves your neighborhood out from his delivery zone.

Does exclude mean not included?

To not include something or someone. leave out. exclude. omit.

What does it mean to exclude a group?

Excluded Group means each member of the Group which is not a member of the Bank Group. Sample 1Sample 2Sample 3. Based on 11 documents.


1 Answers

In NDoc at least, it means that the XML documentation for this member should be excluded. From the documentation:

The <exclude/> tag directs NDoc to exclude the current item from documentation.

It's not clear to me whether this was originally NDoc-specific, but it does also appear to be supported by Sandcastle (in that it's in the Sandcastle XML comments guide).

like image 195
Jon Skeet Avatar answered Sep 21 '22 15:09

Jon Skeet