Software Warlock » cref http://softwareblog.morlok.net Sat, 24 Dec 2011 16:06:59 +0000 en hourly 1 http://wordpress.org/?v=3.1 XML Comments http://softwareblog.morlok.net/2009/11/24/xml-comments/ http://softwareblog.morlok.net/2009/11/24/xml-comments/#comments Wed, 25 Nov 2009 02:21:01 +0000 Warlock http://softwareblog.morlok.net/?p=309 Read more »

]]> Today I was looking for a reference for the proper notation for the cref attribute of the <see cref="..."> C# XML comment tag, and after finding it, I thought I’d post it here for future reference.

The cref (code reference) tag is prefaced by a single character, then a colon, followed by the reference in question. The character defines what is being referenced, as defined by the table below.

Character Description
N Namespace
T Type (class, interface, struct, enum, delegate)
F Field (member variable, constant, etc)
P Property (including indexers and indexed properties)
M Method (including special methods like constructors – #ctor – operators, etc)
E Event
! Error string

The full reference for the prefixes is available here, with the full XML comment documentation available here. The Code Project also has an article on the topic.

]]> http://softwareblog.morlok.net/2009/11/24/xml-comments/feed/ 1