A public method or constructor that does not have a <param> tag for each parameter makes an API more difficult to understand and maintain.

The documentation comment for a method or constructor should include <param> tags that describe each parameter.

The following example shows a good documentation comment, which clearly explains the method's parameter.

  • MSDN, C# Programming Guide: XML Documentation Comments, How to: Use the XML Documentation Features, Recommended Tags for Documentation Comments.