Я, наприклад, додаю код налагодження (наприклад, повідомлення про друк) лише тоді, коли я намагаюся знайти помилку. І як тільки я його знайшов, я видаляю код налагодження (і додаю тестовий випадок, який спеціально тестує цю помилку). Я відчуваю, що це захаращує справжній код, і тому там немає місця, якщо я не налагоджую.
Як ти це робиш? Ви залишаєте код налагодження на місці або видаляєте його, коли застаріло (що може бути складно судити, коли це є)?
Відповіді:
Вийміть налагодження друку заяв; однак, якщо вам потрібно додати їх для налагодження виробничої проблеми, можливо, варто задуматися, чи є у вас достатньо інформації для того, щоб увійти в систему реєстрації. Інформація про параметри, умови помилок тощо може бути корисною згодом, коли з’явиться наступна помилка. Використання хорошої системи ведення журналів, яка може мати налагодження або динамічне включення повідомлень журналу, може бути дуже корисною в дикій природі.
Код, доданий спеціально для налагодження, слід видалити з виробничого програмного забезпечення.
Незалежно від того, чи буде це повне видалення чи розміщення у розділах умовної компіляції (як у C / C ++ / C #), залежить від вас та вашого стандарту кодування.
Для цього є ряд причин:
ChrisF і Аларік обидва мають дійсні точки; +1 для них. Я можу визначити щонайменше 5 різних типів коду налагодження, який я використовую.
Використання журналів для скидання стану системи в певний момент часу.
void function(...)
{
...dump everything i know about.
}
Використання журналів для контрольних пунктів виконання.
void function(...)
{
...got here 1
...got here 2
}
Код, який насправді змушує певну умову бути правдою, але порушує нормальну поведінку. Приклад:
Журнал перевірки - я б класифікував це як багатослівний журнал, який можна використовувати для перевірки правильності програмного забезпечення, яке не повинно включатись у виробництво, як, наприклад, перевірка окремих етапів алгоритму.
Журнал операцій - див . Пост Аларіка . Це майже те, що я маю на увазі під «операційним журналом».
1, 2 і 3 слід витягувати повністю. Щось подібне до 4, я, мабуть, умовно скласти з коду. Для 5-ти років Аларік мав велике значення щодо можливості динамічно вимикати журнали. Це, можливо, стосується точки КріС у другій кулі у більшості випадків.
1)… на 1.… (щоб форматування Markdown вибирало його у вигляді списків) і вводили зразок коду на 8 пробілів (знову ж таки, щоб Markdown вибирав його як приклад код у списку).
Це залежить від того, що робить код. Деякий код, який використовується для налагодження, можна залишити таким, який він є, а деякий слід видалити.
Код, який підтверджує правильність параметрів у методі, не завжди корисний, коли код працює належним чином, але його часто намагаються переконатись у правильності роботи коду.
Іноді ви пишете код по-іншому, щоб полегшити налагодження коду, наприклад, обчисливши значення і ввівши його в локальну змінну, а потім використовуйте змінну в наступному рядку, що полегшує перевірку результату обчислення при однократному кроці через код. Ви можете переписати код, щоб використати обчислене значення безпосередньо, але вартість використання локальної змінної настільки мала (якщо вона взагалі є), що для перезапису коду мало підстав. Крім того, є сенс залишити код незмінним, як тільки ви його протестували, завжди є невеликий ризик, що ви введете помилку при її зміні.
Код, який ви додали лише для відстеження конкретної помилки, часто можна видалити після того, як ви знайшли помилку.
Колись я використовував дуже багато коду налагодження. Я майже цілком орієнтувався на Windows, тому було багато цієї функції виводу рядка налагодження, що я більше не пам'ятаю, як писати написання, тому я міг фіксувати слід за допомогою певної програми.
Деякий код налагодження залишився на місці, конкретні речі, які мали надати вкладення дзвінків. Однак, хоча те, що налагодження рядка в основному не було б видно у виробничій системі, все-таки все робилося за умови умовної компіляції.
Однак реальність полягає в тому, що весь цей налагоджувальний код доклав чимало зусиль для того, що ідеально обробляється по-іншому - використовуючи, звичайно, відладчик. На той момент я не був вражений налагоджувачем Borland C ++. Інструменти були там, але вони занадто часто давали оманливі результати, а використання налагоджувача без IDE (часто необхідного) означало запам'ятовування клавіш швидкого доступу, що означало відволікання від роботи.
Єдиний досвід налагодження, який я виявив, що є гіршим, це командний рядок GDB.
Бути експертом з інструментами, якими ви користуєтесь щодня, звичайно, важливо - але налагодження дійсно не повинно бути тим, що ви робите щодня. Якщо ви часто користуєтеся налагоджувачем, ви все гаразд, вивчаючи десятки команд та / або комбінацій клавіш, це здається мені трохи червоним прапором.
На той час, коли я працював у Visual Studio 7, проте, було зрозуміло, що налагодження може бути дуже практичним та ефективним. Якщо ви можете виконати налагодження у Visual Studio (включені експрес-видання), налагодження - це вітер. Без сумніву, якщо ви можете знайти правильний інтерфейс GUI / IDE, GDB також простий та ефективний, хоча я ще не робив цього пошуку.
Також є що сказати для тестування одиниць, з аналізом покриття за допомогою gcov. Чим впевненіше ви в поведінці своїх бібліотек, тим менш глибокою має бути налагодження - і тим рідше вам потрібен налагоджувач в першу чергу. І писати одиничні тести - це цілком розумно те, що ви повинні робити більшість днів.
Несподівано важливий інструмент = cmake, інструмент побудови, який дозволяє мені легко перемикатися між побудовою для GCC та VC ++, серед іншого. Тож я можу зробити тестування одиниць і покриття на основі gcov за допомогою GCC, але легко перейти на VC ++ для використання налагоджувача.
Моє взяти на себе: Код налагодження, який використовується для вбивства помилки у коді, про який я питаю, я зазвичай повністю видаляю. Код налагодження, що використовується для вбивства помилки внаслідок зовнішніх сил, я зазвичай просто коментую.
Якщо помилка походить від тестування блоку або з внутрішнього, код налагодження може бути видалений зовсім. Але якщо помилка від виробництва, код налагодження краще знаходитись всередині тегів компіляції. Поміщення його всередині тегів компіляції допоможе іншим розробникам зрозуміти, що цей код призначений лише для налагодження.
Використовуйте TDD , тому ваш тестовий код завжди має місце, де його навіть підтримують.