Besides the not so meaningful description, the contents of this blog is actually pretty simple for an experienced .NET developer.
This post is simple about the prefixes of reference IDs used when writing XML documentation. Here is an example of what I'm talking about.
<see cref="E:System.Timers.Timer.Elapsed" />
The tag above means that the documentation should contain a link to the event (prefix: E) Elapsed on the type System.Timers.Timer.
So which prefixes actually exists? For some reason I never get the correct link first time when Googling so here is a quick list.
| N | Namespace |
| T | Type (class, struct, enum, delegate, interface) |
| D | Typedef |
| F | Field |
| P | Property |
| M | Method |
| E | Event |
For further information about the subject visit this page.
Read more!
