Recommended Code Comment XML Elements : Documentation Comments « Language Basics « C# / CSharp Tutorial






  1. C# / CSharp Tutorial
  2. Language Basics
  3. Documentation Comments
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








1.2.Documentation Comments
1.2.1.Documentation Comments for class
1.2.2.Documentation Comments for A member variable
1.2.3.Documentation Comments for A property
1.2.4.Documentation Comments for a method with parameters
1.2.5.Documentation Comments for Main function
1.2.6.Compiler Support Tags
1.2.7.XML Documentation
1.2.8.Recommended Code Comment XML Elements