The <include> tag lets you refer to comments in another file that describe the types and members in your source code. This is an alternative to placing documentation comments directly in your source code file. By putting the documentation in a separate file, you can apply source control to the documentation separately from the source code. One person can work on the source code file and someone else can work on the documentation file.
The <include> tag uses the XML XPath syntax. Refer to XPath documentation for ways to customize your <include> use. This is a top-level tag.
Syntax
<include file="filename" path="tagpath[@name='id']" />
where:
filename
The name of the XML file containing the documentation. The file name can be qualified with a path.
tagpath
The path of the tags in filename that leads to the tag name.
name
The name specifier (attribute) in the tag that precedes the comments; name will have an id.
id
The ID for the tag that precedes the comments. It should be a member full identifier in cref syntax.
Examples
Let's have the following XML comments in a source code:
The external_comments.xml file contains the following:
Then resulting XML comment for prop1 property will be:
|
||||||||||||
