i’m adding comments to some csharp code, and i’m using the xml language provided by .net (or something). i have an interface, and some implementing classes. i have one method in the interface, and it has a comment. in the implementing classes there is no comment on the implementing method.
when one does it like this in java, javadoc automagically uses the interface comment when generating documentation. however, now that i build my project, i get the warning (transalted from swedish, sorry) “the xml comment for the visible type or member bla.blabla.blablabla() is missing (cs1591)”. this is only a warning, so not so bad. but!!! it means no xml file was output, so i can’t use sandcastle to generate a chm document file, which is my real goal here…. googling the error coded gave nothing 🙁
do i really have to copy the method comment to all implementing classes? that’s like…. code duplication D: is there no way to get the behavior java offers?
I don’t know of any way of getting it to happen at XML file generation time, but GhostDoc may well save you from performing the copying manually. I can’t say I’ve used it myself though.
I agree that it would be a valuable feature… particularly if the base class (or interface) documentation changes after the derived classes have been implemented and documented.