Sandcastle XML Comments Guide
 | SampleClassVariousNoteExamples Method |
This shows the result of the various note types.
Namespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
SyntaxRemarksThese are various examples of the different note types.
 Note |
|---|
| This example demonstrates the handling of a note element with no defined type. It defaults to the "note" style. |
| Tip |
|---|
| Always document your code to help others understand how it is used. |
| Notes to Implementers |
|---|
| Override this method in a derived class to do something useful |
| Notes to Callers |
|---|
| Calling this implementation will have no effect at all |
| Notes to Inheritors |
|---|
| Types inheriting this base method will have no use for it as it does nothing |
 Caution |
|---|
| Use of this method is not recommended. |
| Caution |
|---|
| XML is case-sensitive so the note type must be entered as shown in order for it to be interpreted correctly. |
| Important |
|---|
| Calling this method excessively will only slow down your application. |
 Security Note |
|---|
| It is always safe to call this method. |
| Security Note |
|---|
| This method requires no special privileges |
| C# Note |
|---|
| Use parenthesis when calling this method in C#. |
| Visual Basic Note |
|---|
| Parenthesis are not required when calling this method in Visual Basic. |
| C++ Note |
|---|
| Use parenthesis when calling this method in C++. |
| J# Note |
|---|
| Use parenthesis when calling this method in J#. |
See the note topic for a full list of all possible note types.
See Also