2010-03-04 2 views
0

Есть ли смысл писать комментарии в коде?Есть ли смысл писать тип члена класса для каждого члена класса?

/// <Remarks> 
/// Name of abc - public property. 
/// </Remarks> 

В визуальной студии, IntelliSense имеет иконки для каждого типа члена класса (поля, свойства и т.д.), так что я не вижу смысла в этом. В моем текущем магазине мы все равно используем Visual Studio, который предоставляет эти значки.

Thanks

+0

DRY, YAGNI. (Не совсем DRY, но очень * близко и в том же духе.) – 2010-03-05 00:05:47

ответ

1

Кажется довольно бесполезным для меня. Я бы избегал этого, потому что, как вы говорите, это то, что можно сделать из кода тривиально. (edit: FWIW, возможно это полезно для некоторого инструмента, в котором ваша организация работает, чтобы сделать документацию, и этот инструмент недостаточно умен, чтобы обнаруживать свойства и поля, но я сомневаюсь, что это так. Тем не менее, это потенциальная причина для кодировать «избыточные» данные в комментарии (для удовлетворения инструмента (человека или нет: P)).

+0

Это был задание, заданное для младшего разработчика. Что заставило меня смеяться - это кодер с меньшим опытом (меньше опыта без работы), когда его код прокомментировал, когда он действительно должен быть его собственным делом? Комментарии xml не будут выполнены документ, который, как я сказал, был бы прекрасен. – dotnetdev

Смежные вопросы