Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Missing XML comment for publicly visible type or member 'Type_or_Member'
The DocumentationFile compiler option was specified, but one or more constructs did not have comments.
The following sample generates CS1591:
// CS1591.cs
// compile with: /W:4 /doc:x.xml
/// text
public class Test
{
// /// text
public static void Main() // Try the following instead: remove "//" from previous line (`// /// text` about the comments)
//or add #pragma warning disable 1591
//A good practice is to add the following comments:
// /// <summary>
// ///
// /// </summary>
// this can be easily achieved in Visual Studio by simply adding triple forward slashes (`///`) -
// autocomplete will add the summary tags
{
}
}
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.