Как убрать robo-комментарии и #region из C #? - PullRequest
5 голосов
/ 05 июня 2009

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

Это комментарии, исключительно повторяющие метаданные метода и расширения пространства имен в Паскале:

#region methods
/// <summary>
/// Implementation of a public method foo bar, returning a void
/// </summary>
/// <param name="value">A string parameter named value input</param>
public void fooBar(string valueInput)
{

}
#endregion

Есть ли плагин или функция Resharper для удаления комментариев и тегов #region навалом?

Ответы [ 4 ]

4 голосов
/ 05 июня 2009

Почему бы не использовать регулярное выражение найти и заменить в Visual Studio?

Для комментариев с тройной косой чертой:

    ///.*

Для тегов региона:

    [#]region.*
    [#]endregion
1 голос
/ 05 июня 2009

Я голосую за то, чтобы вы вошли и починили их, когда натолкнулись на них. Мне приходилось делать то же самое здесь ... каждый раз, когда я захожу в класс с плохими комментариями (в моем случае: нет). Я комментирую методы / свойства, как я работаю с ними. Через 3 недели я правильно прокомментировал около 1/2 кодовой базы и выработал более глубокое понимание всего проекта.

1 голос
/ 05 июня 2009

Я бы сказал, что заменить их чем-то более разумным, гораздо лучше, чем убрать их. Какими бы обыденными они ни были, отсутствие комментариев всегда хуже (разве что комментарии, конечно, неверны?

Тем не менее, я считаю, это делает то, что вы ищете .

Для тегов регионов вы можете попробовать адаптировать это приложение или использовать регулярное выражение VS найти / заменить.

1 голос
/ 05 июня 2009

Эти части, скорее всего, были напечатаны вручную:

Реализация публичного метода foo bar, возвращающего пустоту

и

Строковый параметр с именем ввода значения

Если это в проекте библиотеки классов, я бы не стал избавляться от xml-комментариев - они будут отображаться в подсказках intellisense для этих элементов. Удаление их может сильно рассердить других разработчиков; для всего текста здесь не очень хорошо, подсказки по умолчанию загадочны и даже хуже.

...