VSdocman can document normal .NET properties easily. You just place your XML comments before property code. This works fine for dependency properties too and even when your property is both, a dependency property and an attached property. In all these cases the property is explicitly defined in the code and there is no problem placing the XML comments.

If you however have pure attached property, there is no place in the code you can add the XML comments. There's only attached property identifier field and getter/setter methods. All of them have their own XML comments used in their own documentation topics. VSdocman solves this problem by taking XML comments from external XML files. You need to create these files manually. The mechanism is the same as if <include> tag was used. The external XML file needs to meet the following conditions:

It must be placed in the same directory as the source code file with the identifier field.

Its name must be the same as name of the source code file with the identifier field, only the extension should be changed to XML. So if you have MyClass.cs or MyClass.vb source code file, the XML file must be placed in the same directory and must be named MyClass.xml.

The XML file may contain comments for multiple attached properties defined in the same source code file. Member's name attribute must have value which equals to a full cref identifier of the attached property, as described in <include> tag help.

Examples

 

See Also