Вопросы с тегом «comments»

Нас попросили добавлять комментарии с начальными тегами, конечными тегами, описанием, решением и т. Д. Для каждого изменения, которое мы вносим в код как часть исправления ошибки / реализации CR. Меня беспокоит, обеспечивает ли это какую-либо дополнительную ценность? Как есть, у нас есть все детали в истории контроля версий, которые помогут …

42 version-control  bug  comments  change 

Является ли хорошей практикой помещать номера ошибок в самом файле внутри заголовка комментария? Комментарии будут выглядеть примерно так: MODIFIED (MM/DD/YY) abc 01/21/14 - Bug 17452317 - npe in drill across in dashboard edit mode cde 01/17/14 - Bug 2314558 - some other error description Это кажется полезным, но считается ли …

40 version-control  development-process  source-code  comments 

Я постоянно вижу людей, заявляющих, что «комментарии имеют тенденцию устаревать». Дело в том, что, думаю, я видел, может быть, два или три устаревших комментария за всю мою карьеру. Устаревшая информация в отдельных документах встречается постоянно, но по моему опыту устаревшие комментарии в самом коде чрезвычайно редки. Мне просто повезло, с …

38 comments  myth 

В процессе программирования вы получите несколько комментариев, объясняющих код, и некоторые комментарии, которые удаляют код: // A concise description const a = Boolean(obj); //b = false; Есть ли хороший метод для быстрого анализа, который какой? Я играл с использованием 3 /-х и /** */для описательных комментариев. Я также использовал плагин …

38 javascript  comments 

Предполагая, что комментарий не помещается (или не может идти) в строке, к которой он относится, следует ли писать комментарий до кода или после? Хорошо, где будущие читатели будут лучше понимать сферу действия комментария. Другими словами, везде, где большинство программистов / сценаристов размещают такие комментарии. Так где же большинство программистов / …

34 comments 

Как обычно обрабатываются комментарии в языках программирования и разметке? Я пишу парсер для некоторого пользовательского языка разметки и хочу следовать принципу наименьшего удивления , поэтому я пытаюсь определить общее соглашение. Например, должен ли комментарий, встроенный в токен, «мешать» токену или нет? Как правило, это что-то вроде: Sys/* comment */tem.out.println() действует? …

31 parsing  comments 

Хотите улучшить этот пост? Предоставьте подробные ответы на этот вопрос, включая цитаты и объяснение того, почему ваш ответ правильный. Ответы без достаточной детализации могут быть отредактированы или удалены. Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 8 лет назад …

27 language-agnostic  comments 

Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 5 лет назад . Я видел это в SO Tavern , поэтому я размещаю вопрос здесь. Я подумал, …

27 source-code  comments  coding-style  grammar 

Этот вопрос был перенесен из переполнения стека, потому что на него можно ответить в Software Engineering Stack Exchange. Мигрировал 8 лет назад . Я хочу услышать от вас любые советы и опыт написания комментариев в вашем коде. Как вы пишете их наиболее простым и информативным способом? Какие у вас привычки, …

26 coding-style  comments 

Закрыто . Этот вопрос основан на мнении . В настоящее время не принимает ответы. Хотите улучшить этот вопрос? Обновите вопрос, чтобы ответить на него фактами и цитатами, отредактировав этот пост . Закрыто 4 года назад . Я только начинаю с функционального программирования, и мне интересно, как правильно комментировать мой код. …

25 functional-programming  comments 

По-видимому, не на одном языке комментарии не могут быть вложенными. У вас есть хорошее решение этой проблемы? Одним из обходных путей в C / C ++ и Java является использование только однострочного комментария, но тогда становится невозможным закомментировать больший блок. Я сталкиваюсь с чем-то вроде этого: </li><!-- <li><!-- Save --> …

23 java  c++  python  c  comments 

Locked . Комментарии к этому вопросу были отключены, но он по-прежнему принимает новые ответы и другие взаимодействия. Узнайте больше . У меня был поиск, но я не нашел то, что искал, пожалуйста, не стесняйтесь связать меня, если этот вопрос уже задавался. Ранее в этом месяце было сделано следующее сообщение: http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ …

22 coding-standards  comments 

Всякий раз, когда я узнаю, что большую часть моего кода необходимо изменить, либо потому, что он некорректен, либо потому, что его нужно адаптировать к серьезным архитектурным изменениям, вызванным другими причинами, я обычно делаю это: Я закомментирую весь код, который, я подозреваю, мне придется изменить. Я рассматриваю закомментированный код как своего …

21 anti-patterns  comments 

Комментировать сейчас проще, чем когда-либо. В Java есть несколько хороших методов для привязки комментариев к классам, и Java IDE хороши для создания оболочек комментариев для вас. Такие языки, как Clojure, даже позволяют вам добавить описание функции в сам код функции в качестве аргумента. Однако мы все еще живем в эпоху, …

20 java  python  clojure  comments 

Из некоторых проектов с открытым исходным кодом я собрал следующий стиль кодирования void someFunction(bool forget); void ourFunction() { someFunction(false /* forget */); } Я всегда сомневаюсь, что falseздесь значит. Означает ли это «забыть», или «забыть» относится к соответствующему параметру (как в случае выше), а «ложь» означает его отрицание? Какой стиль …

19 coding-style  comments  boolean