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

Многие люди утверждают, что «комментарии должны объяснять« почему », а не« как »». Другие говорят, что «код должен быть самодокументированным», а комментарии должны быть скудными. Роберт К. Мартин утверждает, что (перефразируя мои собственные слова) часто «комментарии - это извинения за плохо написанный код». Мой вопрос заключается в следующем: Что плохого …

236 programming-practices  documentation  comments 

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

184 teamwork  team  comments 

Я работал в магазинах, которые производят жизненно важное программное обеспечение, и я имел дело с правилами комментирования, которые должны были сделать код читабельным и потенциально спасти жизни. Однако, по моему опыту, требование превращаться в смертельно опасную рутину, чтобы быть убранным из контрольного списка, не помогает мне сосредоточиться на написании понятного …

142 coding-standards  comments  standards  naming-standards  standardization 

Мой коллега считает, что любое использование комментариев в коде (т. Е. Не метод стиля javadoc или комментарии класса) является запахом кода . Как вы думаете?

100 comments  anti-patterns 

младший разработчик здесь. В настоящее время я работаю один над веб-приложением для крупного клиента моей компании. Я начал в прошлом месяце. Клиент хочет по крайней мере 25% комментариев в каждом из своих программных проектов. Я проверил код предыдущих приложений и вот мои наблюдения: каждый файл начинается с блока комментариев (пакет, …

96 project-management  comments  client-relations  hierarchy 

Я работаю над довольно большим проектом и получил задание сделать несколько переводов для него. Было множество этикеток, которые не были переведены, и пока я копался в коде, я нашел этот маленький кусочек кода //TODO translations Это заставило меня задуматься над смыслом этих комментариев для себя (и других?), Потому что у …

86 documentation  comments 

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

83 comments  clean-code 

Я написал следующий код: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } Здесь есть закомментированная строка. Но я думаю, что это делает код более понятным, делая очевидной …

83 documentation  comments 

Прежде всего, в этом вопросе я бы хотел избежать полемики о том, является ли комментирование исходного кода хорошим или плохим. Я просто пытаюсь понять, что люди имеют в виду, когда говорят о комментариях, которые говорят вам, ПОЧЕМУ, ЧТО или КАК. Мы часто видим рекомендации типа «Комментарии должны указывать, ПОЧЕМУ; сам …

78 documentation  comments 

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

78 version-control  comments 

Меня обучает мой начальник (я только что закончил школу, и он хотел кого-то с небольшим опытом программирования, поэтому он выбрал меня, чтобы обучить меня тому, на чем специализируется эта компания) и начал работать с приложениями ASP.NET MVC , некоторыми HTML и CSS , Я в порядке с вещами веб-дизайна, которые …

72 comments 

Что люди обычно имеют в виду, когда вы видите XXXв комментарии. Иногда я увижу такой комментарий: # XXX - This widget really should frobulate the whatsit Конечно, я могу сказать, что означает комментарий, но что обычно означает XXX? Это говорит "Это взлом" или, может быть, "Мы должны вернуться к этому …

72 comments  coding-standards 

Я просто обнаружил, что пишу следующий комментарий в некотором (архаичном Visual Basic 6.0) коде, который я писал: If WindowState <> 1 Then 'The form's not minimized, so we can resize it safely '... End if Я не уверен, почему я подсознательно использую «мы» в моих комментариях. Я подозреваю, что это …

63 comments  coding-standards 

Фон Я работаю в команде, которая стремится внедрить развертывание без простоев. Мы планируем использовать сине-зеленую стратегию развертывания для достижения этой цели. Одна из вещей, которые я осознаю, выполняя исследования, это то, насколько сложно вносить изменения в базу данных. Простая операция, такая как переименование столбца, может занять 3 полных цикла выпуска, …

51 continuous-integration  deployment  comments  continuous-delivery 

Кто-то однажды сказал, что мы должны поставить перед всеми нашими методами /// <summary>блоки комментариев (C #), но не объяснил, почему. Я начал их использовать и обнаружил, что они меня немного раздражают, поэтому перестал их использовать, за исключением библиотек и статических методов. Они громоздкие, и я всегда забываю обновить их. Есть …

49 c#  comments