Чи слід використовувати дужки в логічних висловлюваннях, навіть якщо це не потрібно?

Скажімо, у мене булева ситуація, a AND b OR c AND dі я використовую мову, де ANDпрецедент вищого порядку функціонування ніж, ніж OR. Я можу написати цей рядок коду:

If (a AND b) OR (c AND d) Then ...

Але насправді це рівнозначно:

If a AND b OR c AND d Then ...

Чи є якісь аргументи «за» або «проти», включаючи сторонні дужки? Чи свідчить практичний досвід, що варто включити їх для читабельності? Або це ознака того, що розробнику потрібно справді сісти і стати впевненим у азі своєї мови?

Хороші розробники прагнуть писати чіткий і правильний код . Дужки в умовних випадках, навіть якщо вони строго не вимагаються, допомагають обом.

Що стосується ясності , подумайте про дужки як коментарі в коді: вони не є строго необхідними, і теоретично грамотний розробник повинен мати можливість з'ясувати код без них. І все-таки ці підказки надзвичайно корисні, адже:

• Вони скорочують роботу, необхідну для розуміння коду.
• Вони дають підтвердження наміру розробника.

Крім того, додаткові дужки, як і відступи, пробіл та інші стандарти стилів, допомагають візуально впорядкувати код логічно.

Що стосується правильності , умови без дужок - це рецепт дурних помилок. Коли вони трапляються, вони можуть бути помилками, які важко знайти - адже часто неправильний стан більшість часу буде вести себе правильно і лише зрідка виходить з ладу.

І навіть якщо ви правильно це зробите, наступна особа, яка працює над вашим кодом, може не робити, або додаючи помилки до виразу, або неправильно розуміючи вашу логіку і тим самим додаючи помилки в іншому місці (як справедливо вказує LarsH).

Я завжди використовую дужки для виразів, що поєднують andі or(а також для арифметичних операцій із подібними питаннями пріоритетності).

Не менш важливо, чи ви впевнені в розумінні мови. Найважливіше - зрозуміти мову n00b, яка йде за вами.

Напишіть свій код найяснішим, однозначним способом. Додаткові дужки часто (але не завжди) допомагають. Поставлення лише одного твердження на рядок часто допомагає. Послідовність стилю кодування часто допомагає.

Існує таке поняття, як занадто багато дужок, але це одна з тих ситуацій, коли вам не знадобиться порада - ви це дізнаєтесь, коли побачите. У цей момент рефактор вашого коду зменшує складність оператора, а не видаляє дужки.

Так

Ви завжди повинні використовувати дужки ... ви не контролюєте порядок пріоритетності ... розробник компілятора робить. Ось історія, яка трапилася зі мною про невикористання дужок. Це вплинуло на сотні людей протягом двох тижнів.

Реальна світова причина

Я успадкував додаток main-frame. Одного разу з ясного синього кольору він перестав працювати. Ось це ... пуф просто зупинився.

Моя робота полягала в тому, щоб якомога швидше це працювало. Вихідний код не змінювався протягом двох років, але раптом він просто припинився. Я спробував скласти код, і він зламався на лінії XX. Я подивився на лінію XX і не міг сказати, що зробить лінію XX розривом. Я попросив детальні характеристики цієї програми, і таких не було. Лінія XX не стала винуватцем.

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

Отже, я вирішив почати вгорі вихідного коду і додати whitespce та рядкові гальма, щоб зробити код більш читабельним. Я помітив, що в деяких випадках існували умови, які поєднувались, ANDі ORце було не чітко розмежоване між тим, які дані ANDредагуються, і тими, що ORредагуються. Тому я почав ставити круглі дужки навколо ANDта ORумови, щоб зробити їх більш зрозумілими.

Коли я повільно рухався вниз, прибираючи його, я періодично економив свою роботу. Якось я спробував скласти код і відбулася дивна річ. Помилка перескочила початковий рядок коду і тепер була внизу. Тож я продовжив, викладаючи умови ANDі ORз паренами. Коли я закінчив його чистити, це спрацювало. Піди розберися.

Тоді я вирішив відвідати магазин операцій і запитати їх, чи нещодавно вони встановили якісь нові компоненти на основний каркас. Вони сказали, що так, ми нещодавно оновили компілятор. Гмммм.

Виявляється, старий компілятор оцінював вираз зліва направо незалежно. Нова версія компілятора також оцінювала вирази зліва направо, але неоднозначний код, що означає незрозуміле поєднання ANDі ORне вдалося вирішити.

Урок, який я навчився з цього ... ВЖЕ, ВЖЕ, ВИНАГИ використовують парени для відокремлених ANDумов і ORумов, коли вони використовуються спільно один з одним.

Спрощений приклад

IF Product = 191 OR Product = 193 AND Model = "ABC" OR Product = 201 OR Product = 202 AND Model = "DEF" ...(код завалений кількома з них)

Це спрощена версія того, з чим я стикався. Були й інші умови зі складними булевими логічними твердженнями.

Я пам’ятаю, як це було:
IF ((Product = 191 OR Product = 193) AND Model = "ABC") OR ((Product = 201 OR Product = 202) AND Model = "DEF") ...

Я не зміг її переписати, оскільки специфікацій не було. Оригінального автора давно не було. Я пам’ятаю інтенсивний тиск. Цілий вантажний корабель був перекинутий у порт і його не можна було вивантажити, оскільки ця маленька програма не працювала. Без попередження Немає змін у вихідному коді. Мені тільки приснилося запитати в Мережевих операціях, чи вони щось змінили після того, як я помітив, що додавання паронів змінює помилки.

Так, якщо є змішані "і" і "або".

Також хороша ідея (), що логічно - одна перевірка.

Хоча найкраще використовувати добре названі функції предикатів та вилучити більшість перевірок та умов, залишаючи їх простими та читабельними.

Дужки в дужках є семантично зайвими, тому компілятор не хвилює, але це червона оселедець - справжнє занепокоєння - це читаність та розуміння програміста.

Я збираюся зайняти радикальну позицію тут і дати сердечне "ні" в дужках a AND b OR c AND d. Кожен програміст повинен знати напам'ять , що пріоритет в булевих виразах йде НЕ> І> АБО , так само , як запам'ятовування ласка , вибачте мій дорогий тітку Саллі для алгебраїчних виразів. Надлишкові розділові знаки просто додають зорового скупчення більшу частину часу в коді без користі для читання програміста.

Крім того, якщо ви завжди використовуєте дужки в логічних та алгебраїчних виразах, то ви відмовляєтесь від використання їх як маркера для того, щоб "щось тут хитре відбувається - дивіться!" Тобто, у випадках, коли ви хочете змінити пріоритет за замовчуванням і оцінити додавання перед множенням, або АБО перед І, круглі дужки є гарним червоним прапором для наступного програміста. Занадто багато використовуйте їх, коли вони не потрібні, і ви стаєте Хлопчиком, який плакав Вовка.

Я хотів би зробити виняток для чого - небудь поза області алгебри (булевої чи ні), таких як покажчик вираження в C, де все більш складною , ніж стандартні ідіоми , як *p++і p = p->nextймовірно , повинні бути круглими дужки , щоб тримати разименованія і арифметичні прямим. І, звичайно, нічого з цього не стосується таких мов, як Lisp, Forth або Smalltalk, які використовують певну форму польської позначення для виразів; але для більшості основних мов логічний та арифметичний пріоритет повністю стандартизований.

Як я бачу це:

ТАК плюси:

• Порядок операцій явний.
• Захищає вас від майбутніх розробників, які не розуміють порядок операцій.

ТАК Мінуси:

• Це може призвести до захаращеного, важкого для читання коду

Ні плюсів:

• ?

НІ Мінуси:

• Порядок операцій неявний
• Код є менш доступним для розробників без чіткого розуміння порядку операцій.

Чи є якісь аргументи «за» або «проти», включаючи сторонні дужки? Чи свідчить практичний досвід, що варто включити їх для читабельності? Або це ознака того, що розробнику потрібно справді сісти і стати впевненим у азі своєї мови?

Якщо нікому більше ніколи не доведеться знову дивитись на мій код, я не думаю, що мені було б байдуже.

Але, з мого досвіду:

• Я час від часу переглядаю свій код (іноді через роки після його написання)
• Інші іноді дивляться на мій код
  • Або навіть розгорнути / виправити це!
• Ні я, ні інший не пам’ятаємо, що саме я думав, коли писав це
• Написання криптовалютного коду "мінімізувати кількість символів" шкодить читабельності

Я майже завжди це роблю, бо довіряю своїй здатності швидко читати і не робити невеликих помилок набагато більше з паренами, ніж нічим іншим.

У вашому випадку я майже впевнено зробив щось на кшталт:

if (a AND b) then ab = true
if (c AND d) then cd = true
If (ab OR cd) Then ...

Так, це більше коду. Так, я можу замість цього зробити необмежені оператори bool. Ні, мені не подобається шанс, коли в майбутньому скидаючи код 1+ років, я неправильно прочитав фантазійні оператори bool. Що робити, якщо я писав код мовою, яка мала інше прізвище І / АБО і мені довелося відскочити назад, щоб виправити це? Я збираюся поїхати, "ага! Я пам'ятаю цю розумну дрібницю, яку я зробив! Мені не потрібно було включати паренів, коли я писав це минулого року, добре, що я пам'ятаю зараз!" якщо це станеться (або ще гірше, хтось інший, хто не знав про цю кмітливість або був кинутий у ситуацію типу «виправити як можна швидше»)?

Розмежування з () робить його набагато простішим, щоб швидко проглянути і зрозуміти пізніше ...

Загальний випадок

У C # множення і ділення має перевагу над додаванням і відніманням.

Тим не менш, StyleCop, інструмент, який застосовує загальний стиль у кодовій базі з додатковою метою зменшити ризик введення помилок за кодом, який може бути недостатньо зрозумілим, має правило SA1407 . Це правило створює попередження з таким фрагментом коду:

var a = 1 + 2 * 3;

Зрозуміло, що результат є , але 7ні 9, але все-таки StyleCop пропонує поставити дужки:

var a = 1 + (2 * 3);

Ваш конкретний випадок

У вашому конкретному випадку є пріоритет AND порівняно з ІЛИ у мові, якою ви користуєтесь.

Це не так, як поводиться кожна мова. Багато інших ставляться до І та АБО однаково.

Як розробник, який працює в основному з C #, коли я вперше побачив ваше запитання і прочитав фрагмент коду, не читаючи того, що ви писали раніше, моя перша спокуса була прокоментувати, що два вирази не однакові. Сподіваюсь, я прочитав ціле питання цілком, перш ніж коментувати.

Ця особливість і ризик того, що деякі розробники можуть вважати, що І і АБО мають однаковий пріоритет, робить ще важливішим додавання дужок.

Не пишіть код з метою, щоб показати, що ви розумні. Напишіть код з метою читабельності, в тому числі людьми, які можуть бути не знайомі з кожним аспектом мови.

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

Або це ознака того, що розробнику потрібно справді сісти і стати впевненим у азі своєї мови?

Якщо ви строго використовуєте мову в однині, можливо. Тепер візьміть усі мови, які ви знаєте, від старих до найсучасніших, від компільованих до сценаріїв у SQL до власного DSL, який ви вигадали минулого місяця.

Ви пам’ятаєте точні правила пріоритетності для кожної з цих мов, не дивлячись?

"Чи слід використовувати дужки в логічних висловлюваннях, навіть якщо це не потрібно."

Так, тому що двоє людей знайдуть їм корисні:

• Наступний програміст, у якого знання, компетентність чи стиль можуть бути різними

• Майбутній ви, хто повернеться до цього коду на якусь пізнішу дату!

Складні умови - це "булева алгебра", яку ви пишете певним чином, що, мабуть, робить це схожим на алгебру, і ви б точно використовували парени для алгебри , чи не так?

Справді корисні правила - це заперечення:

!(A || B) <=> !A && !B
!(A && B) <=> !A || !B

Або в трохи чіткішому форматі:

!(A + B) <=> !A * !B
!(A * B) <=> !A + !B

що насправді явно просто алгебра, коли пишеться як:

-1*(A + B) = -A + -B
-1*(A * B) = -A * -B

Але ми можемо також застосувати мислення для алгебраїчного спрощення та розширення:

(A && B) || (C && D) => 
((A && B) || C) && ((A && B) || D) => 
(AC && BC) && (AD && BD) =>
AC && BC && AD && BD

хоча в коді потрібно написати:

(A||C) && (B||C) && (A||D) && (B||D)

або, у трохи чіткішому форматі:

(A + B) * (C + D) => 
((A + B) * C) + ((A + B) * D) => 
(AC + BC) + (AD + BD) =>
AC + BC + AD + BD

В основному, умовне все ще є лише алгебраїчним виразом, і, чітко використовуючи дужки, ви можете легше застосувати різні алгебраїчні правила, які ви вже знаєте, до виразу, включаючи поняття старого "спростити або розширити цю формулу".

Я буду використовувати дужки, навіть якщо це необов’язково, чому, оскільки це допомагає краще зрозуміти всіх, для того, хто пише код, а також того, хто готовий бачити цей код. У вашому випадку навіть булеві оператори мають перевагу, воно спочатку може спрацювати добре, але ми не можемо сказати, що це допоможе вам у кожному випадку. тому я віддаю перевагу дужкам користувачів у будь-яких умовах, які можуть вимагати цього або необов'язково.

Так. Ви повинні використовувати в будь-якому випадку, коли вважаєте, що ваш код стане більш зрозумілим. Пам'ятайте, що ваш код повинен бути достатньо чітким, щоб інші могли зрозуміти, не читаючи ваших коментарів всередині коду. Тож є хорошою практикою використовувати дужки та дужки. Також майте на увазі, що це може залежати від конкретної практики вашої компанії / команди. Просто дотримуйтесь одного підходу і не змішуйте.