Cheatography
https://cheatography.com
XML Documentation tags for Sandcastle Help File Builder
This is a draft cheat sheet. It is a work in progress and is not finished yet.
Introduction
This cheat sheet has two main parts. The first part gives a brief overview of the possible elements and where the are supported by Sandcastle Help File Builder in XML doc comments in the source code. After this each element is detailed a bit more. |
Used Icons
|
|
|
Not supported by SHFB |
These icons are used on the sections that describe the elements to indicate some additional information.
root elements
<summary> |
Describe the member or type in one or two lines |
<param> |
Describe a parameter |
|
<returns> |
Describe the return value |
<remarks> |
Full description of the member ot the type |
<permission> |
??? |
|
<exception> |
Describe an exception that can be thrown from the member |
|
<inheritdoc> |
Inherit documenation from an ancestor |
<example> |
Provide an example |
<exclude> |
Exclude the member from the documentation |
<filterprioroty> |
Used by the VB editor to filter elements out of the pop-up |
|
<include> |
Import documentation from an external file |
|
<overloads> |
Generic description for member overloads |
<preliminary> |
Shot the documentation as prelimenary |
<seealso> |
Link to other content from the "See Also' section |
|
<threadsafety> |
??? |
<tocexclude> |
Exclude the member from the table of contents |
<typeparam> |
Describe a type parameter of a generic type |
|
<value> |
Describe the value of a property |
block elements
<code> |
Format a block as code. Syntax highlighting is possible. |
<inheritdoc> |
Inherit common documentation form an ancestor |
<list> |
Create a list or a table |
<para> |
Create as a parapraph |
inline elements
<c> |
Format short text as code. |
<note> |
Format the content of the block as a note. Use atributes to set the note type. |
<paramref> |
Reference a parameter of the method. Method name set by attribute name. |
<pre> |
<see> |
In-line reference to an internal (cref), an external (href), or a language specific content (langword). Target of reference set by attribute. |
|
<typeparamref> |
Reference a type parameter of the method. Method name set by attribute name. |
<summary>
The summary provides a short description of the type or the member. This summary is used in intellisense and in various places in the generated documentation.
|
