Writing comments in your source code that are included in the documentation through the XML comment file, you can use special tags supported by Documenter to make your comment text richly formatted and include any links and other help hot spots supported by D2HML.
To format a range of text in your XML comment with any style available in the generated document, use the <span> tag with style attribute. Since it allows you to use all styles, you have the full power of D2HML for creating hot spots of any kind. You can create topic links, keyword links, expanding text and other kinds of hot spots, see D2HML description for details. Note that although standard XML comment tag <see> allows you to create links to assembly element topics, it does not allow you to create links to narrative topics in your help. Using the <span> tag you can easily overcome this limitation; in fact, the <span> tag allows your XML comment text to use all Doc-To-Help features available in Word and HTML source documents via D2HML.
For example, you can add a link to a Doc-To-Help topic like this:
<remarks>These are my remarks and there is a link to <span style=”C1H Jump”>this topic|tag=mytopic</span> here</remarks>
You can also use the <span> tag to format your text with styles to give it the appearance you desire.
Documenter also supports two special tags for formatting for appearance, <b> and <i>, used for bold and italic text. For example,
<remarks>These are my <b>bold</b> remarks</remarks>
You can also add your own tags and attributes to the XML comments. See Adding User-defined Tags and Attributes to XML Comments for more information.