Wulin.com (www.vevb.com) Введение в статью: Я никогда не видел, чтобы какие -либо научные исследования доказывают это, но в области программного обеспечения это похоже на догму или общее убеждение. Из -за своего существования важно легко писать программное обеспечение и обратить внимание на читаемый тип кода. Эти требования могут быть достигнуты с помощью некоторых методов, одним из которых является написание комментариев кода.
Отказ от ответственности: то, что я сказал об избежании комментариев кода, не означает, что я не пишу комментарии, а это значит, что я избегаю написания комментариев кода как можно больше, но я все еще пишу их, когда чувствую, что это того стоит.
Мы тратим больше времени на чтение программного обеспечения, чем на написание программного обеспечения, и я никогда не видел, чтобы какие -либо научные исследования доказывают это, но в области программного обеспечения это похоже на догму или общее убеждение. Из -за своего существования важно легко писать программное обеспечение и обратить внимание на читаемый тип кода. Эти требования могут быть достигнуты с помощью некоторых методов, одним из которых является написание комментариев кода.
Говоря о комментариях кода, всегда есть бесконечные дебаты. Должны ли мы использовать комментарии, чтобы проиллюстрировать роль нашего кода? Должны ли мы сосредоточиться на выражении кода без необходимости комментариев, чтобы помочь в чтении? Джо Канк написал блог о аргументе - не должны ли вы писать комментарии. Некоторые люди говорят, что хорошо документированный код считается хорошим кодом, а некоторые говорят, что следует избегать комментариев, потому что комментарии часто используются для объяснения/скрытия плохого кода.
По моему мнению, под влиянием книг, чтобы гарантировать, что код является аккуратным и простым в рефакторинге, мы должны избегать написания комментариев, если у нас нет веских оснований для написания комментариев (таких как математические алгоритмы) или из -за требований компании или процессов, которые мы обязаны сделать это. Вот пять проблем по поводу заметок.
Где я думаю, что Кодовые комментарии работают контрэффекты 1. Комментарии часто поощряют плохой кодПрокомментированный код - это хороший код, есть такая поговорка, поэтому люди часто добавляют комментарии к коду, чтобы сделать код красивым. Если мы добавим комментарии, чтобы интерпретировать код, это как сигнал: возможно, мы пишем плохой код. Когда мы хотим написать комментарий, мы должны задаться вопросом, можем ли мы сделать его более читабельным, очистив код.
2. Мы будем тратить больше времени на написание и поддержаниеКомментарии обычно являются второй версией кода. Мы на самом деле повторяем себя, когда пишем комментарии для функции. Мы нарушили сухой (не повторяйте себя). Мы тратим больше времени и добавляем сложность. Если требования изменяются, код также должен измениться, и если мы пишем комментарии, мы также должны их изменить. Так что внесите изменения в два раза больше времени, когда вы проводите. Мы можем использовать это время для улучшения нашего кода или разработки новых функций.
3. Комментарии не являются тестируемыми и провереннымиКогда мы модифицируем код, мы используем компиляторы, IDE и инструменты для тестирования модуля для помощи, и нет никаких комментариев и аналогичных инструментов. Вы не можете полагаться на инструменты или модульные тесты, чтобы убедиться, что они используются правильно, аннотации даты и т. Д. После того, как вы напишите комментарий, потому что он станет непроверенным и не может обратить внимание на свою точность, он будет сохранен незаметно, как только пойдет не так.
4. Комментарии ненадежны по сравнению с кодомОбычно, когда комментарии и код выходят из этого, это становится менее значимым. Если программист читает это, это может быть введено в заблуждение. Даже без вводящего в заблуждения вам нужно прочитать исходный код, чтобы выяснить, что вы делаете. Для практического примера, если наш босс нуждается в том, чтобы внести модификацию, мы должны рассмотреть комментарии или код? Конечно, мы рассмотрим код.
5. Комментарии занимают много места для экранаНекоторые методы комментариев (например, приведенные ниже) занимают много строк, что становится проблемой, когда вы хотите увидеть больше кода.
/**
*
* @param Название Название компакт -диска
* @param Автор автор компакт -диска
* @param отслеживает количество треков на компакт -диске
* @param durationinminminting продолжительность компакт -диска за считанные минуты
*/
public void AddCD (название строки, автор строки,
int треки, int durationinminutes) {
CD CD = новый CD ();
cd.title = title;
CD.Author = автор;
CD.Tracks = треки;
cd.duration = продолжительность;
cdlist.add (cd);
}