Aug 31, 2013 at 8:18 PM
Edited Aug 31, 2013 at 8:30 PM
XML schema files have two different annotation elements:
. The annotation element is for human readable text and the convention is pretty much to use plain text for this element. As such, it doesn't really support pre-formatted content, such as line breaks. Most tools will simple collapse all
whitespaces and remove line breaks.
The app info element is meant for machine readable annotations and can contain abitrary XML. XML Schema documenter will look for a
element from the namespace
. You can use this element to get structured documentation.
For example, this schema annotation
The first line.
This is the summary.
This is the first paragraph.
This is another paragraph.
This is code.
<ddue:para>This is a note.</ddue:para>
will render like this:
Please note that the
element only supports a single
element. This is a limitation in the XML documentation used by Sandcastle called MAML. For more details on MAML have a look at Eric's
For more details on XML Schema documentation, have a look at xsddoc's help file that you can find here:
%ALLUSERSPROFILE%\EWSoftware\Sandcastle Help File Builder\Components and Plug-Ins\XML Schema Documenter\Help.chm
In particular, have a look at Documenting | Inline Documentation
Does this help?