StyleCop SA1630

Question

这些方法之间有什么不同，为什么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)
        {

        }

谢谢!

Answer 1

有些参数只有一个单词作为文档，这显然是不够的(至少需要10个字符+至少一个空格)。

• Sender
• Authority

就这些参数的用途编写一个有用的描述。

此外，对于事件处理程序，您确实应该采用Microsoft使用的文档文本：

/// <summary>
/// Handles the XXXXX event of YYYY.
/// </summary>
/// <param name="sender">The source of the event.</param>
/// <param name="e">The <see cref="EventArgs"/> instance containing the event data.</param>

Answer 2

不同之处在于，文档使用一个词来描述Page_Load()事件和GetCases()方法的一个参数，而SortDropDown()方法文档使用多个单词来描述其参数。更具描述性，您将避免违反此规则。