Lets Have a fun with Technology.

BTemplates.com

Follow by Email

Friday, November 30, 2012

Visual Studio Warning : Missing XML comment for publicly visible type or member


Missing XML comment for publicly visible type or member 


You are getting this warning because your publicly visible types and members do not contains XML comment. You can disable this warning message by "Turn off the comment generation (in project properties)" but Best practice is to include comment in each publically visible types and members.


Add XML comments as shown below.

///<Summary>
/// gets the answer
///</Summary>
Public string Method()
{
   return "Now I am not getting, Missing XML comment for publicly visible    type or member ";
}



Why to include comments.
You are getting this error because your Visual studio editor set project to output documentation xml file (in the project settings). This is useful for class libraries (.dll assemblies) which mean users of your .dll are getting intelligence documentation for your API right there in visual studio.



0 comments:

Post a Comment