Стандарты для использования генераторов документов, таких как sandcastle для Windows Form App

Question

Я размещал комментарии XML в классах, которые я создал сам, но никогда в классах, создаваемых Visual Studio, таких как классы форм и их методы событий.

Мой вопрос: должен ли я также добавлять комментарии XML в классы классов? например

/// <summary> 
/// Saves some foo. 
/// </summary> 
/// <param name="sender">The object sender.</param> 
/// <param name="e">The event args.</param> 
private void buttonSave_Click(object sender, EventArgs e) 
{ 
    ...Run some codes here... 
} 

О, и, как правило, я минимизирую любую логику внутри метода события. Обычно я просто вызываю другой метод из другого класса, который я создал, и вместо этого помещаю комментарии XML в этот метод. Например:

private void buttonSave_Click(object sender, EventArgs e) 
{ 
    FooClass fooClass = new FooClass(); 

    fooClass.saveFoo() 
} 

/// <summary> 
/// Saves some foo. 
/// </summary> 
private void saveFoo(object sender, EventArgs e) 
{ 
    ...Run some code here... 
} 

Answer 1

Я думаю, вы должны прокомментировать эти методы. Даже если они находятся в сгенерированных классах, методы не генерируются, а разрабатываются вручную (и они не перезаписываются).

Я бы прокомментировал все методы - просто чтобы избежать предупреждений или ошибок (в зависимости от настройки).