StyleCop标题文档



刚开始使用StyleCop,我遇到了一些问题,无法解决。

第一个例子是我的主要例子,它给了我一个SA1612错误,说标签不匹配。

/// <summary>
/// Main Method to run the program
/// </summary>
/// <param name="UserInput">function that gets the input</param>
public static void Main(string[] args)
{
UserInput();
}

第二个例子是我的函数,它说文档并没有包含所有的param标记。SA1611

/// <summary>
/// Gets by boolean if the input is Binary and 7 digits long
/// <param name="num">integer type a number user enters</param>
/// </summary>
/// <returns>True or false</returns>
private static Boolean LegitBinary(int num)
{
while (num != 0)
{
if (num % 10 != 0 && num % 10 != 1)
{
return false;
}
num /= 10;
}
return true;
}

我在几乎所有的函数上都得到了和第二个例子中相同的错误。非常感谢您的帮助。

第一个示例:
参数名为UserInput,与实际名称args不匹配。

第二个示例:
<param>...</param>节不应包含在<summary>...</summary>节中。

最新更新