使用StyleCop遇SA1612、SA1611错误，求解决方法

一、SA1612（标签不匹配）错误修复 #

错误原因：Main方法的XML注释中，<param>标签的name属性值UserInput与方法实际参数名args不匹配，且注释描述与参数实际作用不符。

修复后的代码：

/// <summary>
/// Main Method to run the program
/// </summary>
/// <param name="args">命令行输入参数</param>
public static void Main(string[] args)
{
    UserInput();
}

若Main方法未使用args参数，可直接删除多余的<param>标签：

/// <summary>
/// Main Method to run the program
/// </summary>
public static void Main(string[] args)
{
    UserInput();
}

二、SA1611（文档结构错误）错误修复 #

错误原因：XML注释将<param>标签嵌套在了<summary>标签内部，违反了文档注释的结构规范，导致StyleCop无法正确识别参数注释。

修复后的代码：

/// <summary>
/// 判断输入是否为二进制数并返回布尔值
/// </summary>
/// <param name="num">用户输入的整数</param>
/// <returns>符合二进制格式返回True，否则返回False</returns>
private static Boolean LegitBinary(int num)
{
    while (num != 0)
    {
        if (num % 10 != 0 && num % 10 != 1)
        {
            return false;
        }

        num /= 10;
    }

    return true;
}

通用修复规则（解决所有函数的同类错误） #

所有函数的XML注释必须遵循固定结构顺序：

• 首先是<summary>标签，描述方法的核心功能
• 然后是所有<param>标签，每个参数对应一个，name属性必须与方法参数名完全一致，顺序和方法参数顺序保持同步
• 最后是<returns>标签（仅针对有返回值的方法）

注意：<param>标签不能嵌套在<summary>或其他标签内部，必须作为独立的同级标签存在。

内容的提问来源于stack exchange，提问作者Nick Yurchenko