THAX10001 - inyutin-maxim/ThirdHand.Analyzers GitHub Wiki
Behavior: Analyzes types and their public members for missing documentation and suggests adding it.
Diagnostic code: REO13001
Message: Missing XML doc comment on type(s) and/or member(s).
Fix: Adds XML doc comments to the type(s) and all of its public members.
Incorrect code:
public class ValidCase
{
private readonly int _number;
public int Count { get; set; }
public ValidCase(int number)
{
_number = number;
}
public Task TestMethodAsync()
{
}
private int Sum(int a, int b) => a + b;
}
Correct code:
/// <summary>
///
/// </summary>
public class ValidCase
{
private readonly int _number;
/// <summary>
///
/// </summary>
public int Count { get; set; }
/// <summary>
/// Initialize new instance of <see cref="ValidCase" />
/// </summary>
/// <param name="number"> </param>
public ValidCase(int number)
{
_number = number;
}
/// <summary>
///
/// </summary>
public Task TestMethodAsync()
{
}
private int Sum(int a, int b) => a + b;
}