Compiler Warning (level 4) CS1591
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 add the following comments:
// /// <summary>
// ///
// /// </summary>
// this can be easily achieve at Visual Studio in a simple way adding triple forward slashes (`///`)
{
}
}
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.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for