Where should the XML comments go? 1

[adam0101]

I have an interface and a class that implements that interface. I want to include XML comments, but where should I put them? On the interface, the class that implements it, or both? Also, I want to include comments on the exceptions that will be thrown. Since those would depend on how the interface is implemented, should those comments only be in the class?

Are there any common standards for this?

Thanks,

Adam

http://adameslinger.blogspot.com/

 

[Aptitude]

In short the comments should be on both.

The interface should detail what someone that implements the interface may want to know and the class should details things specific to that implementation. So the exceptions should only go on the class. You may want to put something in the interface's remarks that says "Implementers should throw XxxException if Y happens.

 

[adam0101]

That's kind of what I was thinking too. Thanks.

Adam

http://adameslinger.blogspot.com/