Запитання з тегом «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 …

31 parsing  comments 

Хочете вдосконалити цю посаду? Надайте детальні відповіді на це питання, включаючи цитати та пояснення, чому ваша відповідь правильна. Відповіді без достатньої кількості деталей можуть бути відредаговані або видалені. Це питання було перенесено із переповнення стека, оскільки на нього можна відповісти на Exchange Software Stack Exchange. Мігрували 8 років тому . …

27 language-agnostic  comments 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 5 років тому . Я бачив, що це запитували в таверні "SO" , тому я тут публікую запитання. …

27 source-code  comments  coding-style  grammar 

Це питання було перенесено із переповнення стека, оскільки на нього можна відповісти на Exchange Software Stack Exchange. Мігрували 8 років тому . Я хочу почути від вас будь-які поради та досвід написання коментарів у вашому коді. Як ви пишете їх найбільш простим та інформативним способом? Які звички ви маєте, коментуючи …

26 coding-style  comments 

Закрито . Це питання ґрунтується на думці . Наразі відповіді не приймаються. Хочете вдосконалити це питання? Оновіть питання, щоб на нього можна було відповісти фактами та цитатами, відредагувавши цю публікацію . Закрито 4 роки тому . Я тільки починаю з функціонального програмування і мені цікаво, як правильно коментувати свій код. …

25 functional-programming  comments 

Здається, що не лише однією мовою коментарі не можуть бути вкладені. У вас є гарне рішення цієї проблеми? Одне з вирішень C / C ++ та Java - це використовувати лише однорядковий коментар, але тоді неможливо коментувати більший блок. Я стикаюся з чимось таким: </li><!-- <li><!-- Save --> Тому я …

23 java  c++  python  c  comments 

Заблокований . Коментарі до цього питання вимкнено, але він все ще приймає нові відповіді та інші взаємодії. Дізнайтеся більше . У мене був пошук, але я не знайшов того, що шукав, будь ласка, не соромтеся зв’язати мене, якщо це питання вже задавали. Раніше цього місяця це повідомлення було зроблено: 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