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() используется более одного слова для описания его параметра.Будьте более наглядны, и вы избежите нарушения этого правила.