About XML Documentation comments for overriden functions

[Shengtian Yang]

Hi,

I am writing the XML Documentation comments and useing the "Sandcastle Help
File Builder" to generate the document, but one problem is encountered.

There are several classes derived from the common abstract (template) class.
Though each class overides several abstract or virtual functions defined in
the abstract class, the documentation for those functions remain unchanged.

The simplest way is just to copy all the XML comments from the base class to
the derived class, but I am not satisfied with it, so is there any better
solutions? (If I don't write any XML comments for overriden functions, then
the "Sandcastle Help File Builder" will not generate the document for those
overriden functions based on the document of base fucntions.)

Thanks.

 

[Omar Abid]

Hi,

I am writing the XML Documentation comments and useing the "Sandcastle Help
File Builder" to generate the document, but one problem is encountered.

There are several classes derived from the common abstract (template) class.
Though each class overides several abstract or virtual functions defined in
the abstract class, the documentation for those functions remain unchanged.

The simplest way is just to copy all the XML comments from the base class to
the derived class, but I am not satisfied with it, so is there any better
solutions? (If I don't write any XML comments for overriden functions, then
the "Sandcastle Help File Builder" will not generate the document for those
overriden functions based on the document of base fucntions.)

Thanks.

Hi,
Check out this link : http://expressdotnet.freehostia.com
Omar Abid