SampleClass.VariousNoteExamples Method

Sandcastle XML Comments

previous page next page
Sandcastle XML Comments GuideSampleClassVariousNoteExamples Method
This shows the result of the various note types.

Namespace: XMLCommentsExamples
Assembly: XMLCommentsExamples (in XMLCommentsExamples.dll) Version: 2014.1.26.0
Syntax
Copy
public virtual void VariousNoteExamples()
Public Overridable Sub VariousNoteExamples
public:
virtual void VariousNoteExamples()
abstract VariousNoteExamples : unit -> unit 
override VariousNoteExamples : unit -> unit
Remarks

These are various examples of the different note types.

Note Note
This example demonstrates the handling of a note element with no defined type. It defaults to the "note" style.
Tip Tip
Always document your code to help others understand how it is used.
Note Notes to Implementers
Override this method in a derived class to do something useful
Note Notes to Callers
Calling this implementation will have no effect at all
Note Notes to Inheritors
Types inheriting this base method will have no use for it as it does nothing
Caution note Caution
Use of this method is not recommended.
Caution note Caution
XML is case-sensitive so the note type must be entered as shown in order for it to be interpreted correctly.
Important note Important
Calling this method excessively will only slow down your application.
Security note Security Note
It is always safe to call this method.
Security note Security Note
This method requires no special privileges
C# note C# Note
Use parenthesis when calling this method in C#.
Visual Basic note Visual Basic Note
Parenthesis are not required when calling this method in Visual Basic.
C++ note C++ Note
Use parenthesis when calling this method in C++.
J# note 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
previous page start next page