Запитання з тегом «comments»

Багато людей стверджують, що "коментарі повинні пояснювати" чому ", а не" як "". Інші кажуть, що «код повинен бути самодокументованим», а коментарі мають бути мізерними. Роберт К. Мартін стверджує, що (перефразувавши мої власні слова) часто "коментарі - це вибачення за погано написаний код". Моє запитання таке: Що поганого в поясненні …

236 programming-practices  documentation  comments 

Один із членів моєї команди постійно уникає коментарів у своєму коді. Його код не є самодокументуванням, а іншим програмістам важко зрозуміти його код. Я кілька разів просив його прокоментувати його код, однак він просто дає виправдання або заявляє, що зробить це пізніше. Його стурбованість полягає в тому, що додавання коментарів …

182 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? Це приказка "Це злом" чи, можливо, "Ми повинні переглянути це пізніше"? Або це говорить …

71 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 

Фон Я працюю в команді, яка хоче реалізувати розгортання з нульовим простоєм. Для цього ми плануємо використовувати стратегію синього / зеленого розгортання. Однією з речей, які я усвідомлюю при проведенні дослідження, є те, наскільки складним є внесення змін до бази даних. Така проста операція, як перейменування стовпця, може тривати три …

51 continuous-integration  deployment  comments  continuous-delivery 

Хтось одного разу сказав, що ми повинні префіксувати всі наші методи /// <summary>блоками коментарів (C #), але не пояснив чому. Я почав їх використовувати і виявив, що вони мене дуже дратували, тому перестав їх використовувати, за винятком бібліотек та статичних методів. Вони громіздкі, і я завжди забуваю їх оновлювати. Чи …

49 c#  comments