IForeSub.XMLDocumentation

Syntax

XMLDocumentation: IXmlDomDocument;

Description

The XMLDocumentation property returns the XML comment that is set for the current procedure/function/constructor.

Comments

The XML comment is created as follows:

The root element is an element consisting of an opening and a closing tag. Element name matches with the name of the current procedure/function/constructor.

Child elements will be all comments starting with three slashes.

The XML comment will be returned if there are some errors that prevent from creating XML structure:

The structure has comments starting with two slashes or multiline comments enclosed in figured brackets.
The comment has tags with syntax errors, one of the tags is missing or there are some other errors.

Example

The example of use is given in description of the IForeAssembly.BindToClass method.

See also:

IForeSub | Comments