Document comments should reference existing parameters

문서 > Datadog 보안 > Code Security > Static Code Analysis (SAST) > SAST Rules > Document comments should reference existing parameters

이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

Metadata

ID: csharp-best-practices/reference-documentation-comment

Language: C#

Severity: Notice

Category: Best Practices

Description

This rule emphasizes the importance of accurately documenting method parameters in C#. Inaccurate or missing documentation can lead to confusion and mistakes when other developers use your code. The XML comments above a method, specifically the <param> tags, should match the actual parameters of the method.

The violation occurs when there is a discrepancy between the parameters mentioned in the XML comments and the actual parameters of the method. This could be a misspelled parameter name or a parameter mentioned in the comments that does not exist in the method signature.

How to Remediate

To fix this issue, always ensure that your XML comments accurately reflect your method signatures. Review your comments carefully whenever you add, remove, or rename method parameters. This not only prevents this rule violation but also improves the clarity and maintainability of your code. For example, in the method public void foo(string foo, string bar), the XML comment should include <param name="foo"></param> and <param name="bar"></param> to accurately document the parameters.

Non-Compliant Code Examples

/// a method doing something
/// <param name="fooo"></param>
public void foo(string foo) {

}

public class MyClass()
{
    /// a method doing something
    /// <param name="fooo"></param>
    public void foo(string foo) {

    }
}

Compliant Code Examples

/// <summary>
/// Creates an instance of the specified .NET type from the <see cref="JToken"/> using the specified <see cref="JsonSerializer"/>.
/// </summary>
/// <typeparam name="T">The object type that the token will be deserialized to.</typeparam>
/// <param name="jsonSerializer">The <see cref="JsonSerializer"/> that will be used when creating the object.</param>
/// <returns>The new object created from the JSON value.</returns>
public T? ToObject<T>(JsonSerializer jsonSerializer)
{
    return (T?)ToObject(typeof(T), jsonSerializer);
}


/// <summary>
/// Returns the JSON for this token using the given formatting and converters.
/// </summary>
/// <param name="formatting">Indicates how the output should be formatted.</param>
/// <param name="converters">A collection of <see cref="JsonConverter"/>s which will be used when writing the token.</param>
/// <returns>The JSON for this token using the given formatting and converters.</returns>
[RequiresUnreferencedCode(MiscellaneousUtils.TrimWarning)]
[RequiresDynamicCode(MiscellaneousUtils.AotWarning)]
public string ToString(Formatting formatting, params JsonConverter[] converters)
{
}

public class MyClass()
{
    /// a method doing something
    /// <param name="foo"></param>
    public void foo(string foo, string bar) {

    }
    /// <summary>
    /// When implemented, controls the binding of a serialized object to a type.
    /// </summary>
    /// <param name="wefwe">The type of the object the formatter creates a new instance of.</param>
    /// <param name="wef">Specifies the <see cref="Assembly"/> name of the serialized object.</param>
    /// <param name="wefwe">Specifies the <see cref="System.Type"/> name of the serialized object.</param>
    void foo(string wefwe, out string? wef, out string? wefwe);
}
}