I am using XML Documentation comments to document a new project. All of my public API methods are documented using the three slashes required for XML documentation.
My internal methods (protected and private) are documented using double slashes (
//) and slash star (
/* */). This is because I do not believe these comments should appear in the public API documentation. For example, I developed a group of classes today that use the Chain of Responsibility pattern (http://www.dofactory.com/net/chain-of-responsibility-design-pattern), however I do not believe the users of these classes need to know that the Chain of Responsibility pattern is used internally - only others developers of these classes need to know this.
Have I understood this correctly i.e. is XML Documentation used to document the external API only? Should I even be saying that these classes use the Chain of Responsibility pattern (or whatever pattern I use).
The reason I ask is because other developers will be looking at this code soon and I am trying to promote the principle of least astonishment.