Mega Code Archive

 

Categories / C# Tutorial / Language Basics

 

Recommended Code Comment XML Elements

Predefined XML Element            Meaning in Life <c>                               code font <code>                            Indicates multiple lines should be marked as code <example>                         Mocks up a code example <exception>                       Documents which exceptions a given class may throw <list>                            Inserts a list or table into the documentation file <param>                           Describes a given parameter <paramref>                        Associates a given XML tag with a specific parameter <permission>                      Documents the security constraints for a given member <remarks>                         Builds a description for a given member <returns>                         Documents the return value of the member <see>                             Cross-references related items in the document <seealso>                         Builds an "also see" section within a description <summary>                         Documents the "executive summary" for a given member <value>                           Documents a given property