风格警察 SA1630
这些方法之间有什么区别,为什么 SortDropDown 正确但 Page_load 和 GetCases 不正确?
我无法理解。
以及如何解决这个问题?
编辑在图片上看不清
代码:
/// <summary>
/// Sort items in drop down list
/// </summary>
/// <param name="dropDown">Drop down list</param>
internal static void SortDropDown(ref DropDownList dropDown)
{
}
/// <summary>
/// PageLoad event handler
/// </summary>
/// <param name="sender">Sender</param>
/// <param name="e">Event Args</param>
protected void Page_Load(object sender, EventArgs e)
{
}
/// <summary>
/// Get all cases by authority and ShopNo
/// </summary>
/// <param name="authority">Authority</param>
/// <param name="shopNo">Shop No</param>
/// <returns>Cases list</returns>
private static IEnumerable<CaseSummary> GetCases(string authority, string shopNo)
{
}
谢谢!
What difference between this methods, why SortDropDown is correct but Page_load and GetCases are not ?
I cant understand.
And how to fix this?
Edit cant see well on picture
Code:
/// <summary>
/// Sort items in drop down list
/// </summary>
/// <param name="dropDown">Drop down list</param>
internal static void SortDropDown(ref DropDownList dropDown)
{
}
/// <summary>
/// PageLoad event handler
/// </summary>
/// <param name="sender">Sender</param>
/// <param name="e">Event Args</param>
protected void Page_Load(object sender, EventArgs e)
{
}
/// <summary>
/// Get all cases by authority and ShopNo
/// </summary>
/// <param name="authority">Authority</param>
/// <param name="shopNo">Shop No</param>
/// <returns>Cases list</returns>
private static IEnumerable<CaseSummary> GetCases(string authority, string shopNo)
{
}
Thanks!
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
您的某些参数只有一个单词作为文档,这显然是不够的(至少需要 10 个字符+至少一个空格)。
Sender
Authority
编写有关这些参数用途的有用描述。
另外,对于事件处理程序,您确实应该采用 Microsoft 使用的文档文本:
Some of your parameters have a single word as documentation, which is obviously not enough (at least 10 characters + at least a whitespace are required).
Sender
Authority
Write a useful description about what is the purpose of these parameters.
Also, for event handlers, you really should adopt the documentation text that Microsoft uses:
不同之处在于,文档使用一个词来描述
Page_Load()
事件和GetCases()
方法的参数之一,而SortDropDown()< /code> 方法文档使用多个单词来描述其参数。更具描述性,您将避免违反规则。
The difference is that the documentation uses one word to describe one of the parameters for the
Page_Load()
event andGetCases()
method, whereas theSortDropDown()
method documentation uses more than one word to describe its parameter. Be more descriptive and you will avoid this rule violation.