Оформление и рефакторинг сложных логических выражений

В сложных логических выражениях нередко самому автору спустя какое-то время тяжело разобраться, не говоря уже о других программистах. Предлагаемая методика позволяет повысить наглядность таких выражений путем оформления в виде И-ИЛИ дерева и одновременно выполнять их рефакторинг.

Возьмем для примера фрагмент кода из типовой бухгалтерии

Если ((НомерИзменяемойКолонки = "4") Или (НомерИзменяемойКолонки = "5"))
Или (((НомерИзменяемойКолонки = "7") Или (НомерИзменяемойКолонки = "8")
И (ГруппаРасчета = мИдГруппы7))) Тогда
Расчет(ГруппаРасчета);
КонецЕсли;

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

Приоритеты логических операций

Для начала вспомним приоритеты логических операций. Сначала выполняется Не, потом И и затем Или. Скобки традиционно имеют наивысший приоритет выполнения и гарантируют порядок выполнения вложенных в них операций. Однако их избыточное применение создает продемонстрированные в примере трудности. Зачастую скобки ставят лишь для того, чтобы перестраховаться в сложных и плохо читаемых логических выражениях.

Методика И-ИЛИ дерева

Я же предлагаю сложные логические выражения оформлять в виде И-ИЛИ дерева. Под И-ИЛИ деревом я подразумеваю дерево, нетерминальные узлы которого представляют собой группы (последовательности) одинаковых логических операций И или ИЛИ, а терминальные — остальные логические выражения. Хорошим примером такого дерева является отбор настроек компоновки данных, правда у него верхняя (корневая) группа всегда имеет тип "И". В случае встроенного языка мы этим не ограничены и можем использовать любой тип верхней группы. В рассмотренном примере как раз сверху расположена группа "ИЛИ".

1. Встаем на первую открывающую скобку и с помощью сочетания клавиш CTRL+] находим тело первого узла и переносим целиком в одну следующую строку с отступом относительно слова Если

Если
((НомерИзменяемойКолонки = "4") Или (НомерИзменяемойКолонки = "5"))
Или (((НомерИзменяемойКолонки = "7") Или (НомерИзменяемойКолонки = "8")
И (ГруппаРасчета = мИдГруппы7))) Тогда

2. Следующий логический оператор будет И или ИЛИ. Он и определяет тип группы этого уровня при условии что все группы обрамлены скобками. Для повышения наглядности вставляем в начало группы операцию с не нарушающим результат вычисления группы константным значением. Для И это будет ИСТИНА, а для ИЛИ это будет ЛОЖЬ. ИСТИНА не меняет результат конъюнкции (ИСТИНА И), и ЛОЖЬ не меняет результат дизъюнкции (ЛОЖЬ ИЛИ). Рассмотрим преобразование выражения примера к И-ИЛИ дереву.

Если Ложь
Или ((НомерИзменяемойКолонки = "4") Или (НомерИзменяемойКолонки = "5"))
Или (((НомерИзменяемойКолонки = "7") Или (НомерИзменяемойКолонки = "8")
И (ГруппаРасчета = мИдГруппы7))) Тогда

3. Встаем на следующую открывающую скобку корневого уровня и повторяем шаг 1.

Если Ложь
Или ((НомерИзменяемойКолонки = "4") Или (НомерИзменяемойКолонки = "5"))
Или (((НомерИзменяемойКолонки = "7") Или (НомерИзменяемойКолонки = "8") И (ГруппаРасчета = мИдГруппы7))) Тогда

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

Если Ложь
Или ((НомерИзменяемойКолонки = "4") Или (НомерИзменяемойКолонки = "5"))
Или (((НомерИзменяемойКолонки = "7") Или (НомерИзменяемойКолонки = "8") И (ГруппаРасчета = мИдГруппы7)))
Тогда

5. Далее повторяем шаги 1-3 для всех вложенных узлов (условий в скобках). Следует заметить, автор оригинального выражения не все группы обрамил скобками и последние 2 оператора из числа образующих группы различны и не разделены скобками. В итоге получаем

Если Ложь
Или (Ложь
Или (НомерИзменяемойКолонки = "4")
Или (НомерИзменяемойКолонки = "5"))
Или (Ложь
Или (НомерИзменяемойКолонки = "7")
Или (Истина
И (НомерИзменяемойКолонки = "8")
И (ГруппаРасчета = мИдГруппы7)))
Тогда

6. Теперь нам становится понятно, что логическое выражение можно упростить. Все вложенные однотипные (И или ИЛИ) группы можно смело всегда поднимать в родительскую группу.

Если Ложь
Или (НомерИзменяемойКолонки = "4")
Или (НомерИзменяемойКолонки = "5")
Или (НомерИзменяемойКолонки = "7")
Или (Истина
И (НомерИзменяемойКолонки = "8")
И (ГруппаРасчета = мИдГруппы7))
Тогда

7. В таком виде уже можно довольно безопасно убрать скобки вокруг условий внутри строк. В итоге получаем

Если Ложь
Или НомерИзменяемойКолонки = "4"
Или НомерИзменяемойКолонки = "5"
Или НомерИзменяемойКолонки = "7"
Или (Истина
И НомерИзменяемойКолонки = "8"
И ГруппаРасчета = мИдГруппы7)
Тогда

Кажется, что в итоге получилось заметно более простое и наглядное выражение. В исходном выражении было 16 скобок, в преобразованном — всего 2.

По идее, как изначально оформлять логические выражение по этой методике уже должно быть понятно.

Хочу обратить ваше внимание на отсутствие унарной операции НЕ как типа группы. При желании конечно можно было бы ввести в методику и группу НЕ, но она слишком отличается от рассмотренных и я лично сторонник обходить ее стороной и опускать на самые нижние узлы.

 

Думаю, что эту методику можно успешно применять не только к встроенному языку 1С, но и многим другим языкам.

Использую эту методику уже много лет.

Плюсы:

— повышает наглядность выражения после некоторого привыкания
— облегчает рефакторинг, т.к. позволяет четко видеть пути упрощения (устранения избыточности) выражения
— облегчает отладку, т.к. позволяет быстро комментировать(выключать)/раскомментировать(включать) фрагменты выражения
— облегчает изменение порядка фрагментов выражения
— позволяет дописывать комментарии к каждому узлу дерева
— сокращает левые отступы, вложенность условий, количество строк в коде по сравнению с некоторыми другими подходами

Минусы:

— не все сразу понимают чисто оформительское назначение "Истина И" и "Ложь Или"
— уходит больше времени на начальное написание выражения
— выражение занимает большее число строк
— часто не оправдывает себя в простых выражениях
— автоформатирование кода выравнивает все строки условия по одной границе

Шаблоны

Для удобства написания сложных логических выражений по этой методике рекомендую добавить себе шаблоны

Условие с корневой группой "И" —

Если Истина
    И <?>
Тогда
КонецЕсли;

Условие с корневой группой "Или"

Если Ложь
    Или <?>
Тогда
КонецЕсли;

96 Comments

  1. fixin

    а не проще ли для этого примера по другому?

    Если ((НомерИзменяемойКолонки = «4») Или (НомерИзменяемойКолонки = «5»))

    Или (((НомерИзменяемойКолонки = «7») Или (НомерИзменяемойКолонки = «8»)

    И (ГруппаРасчета = мИдГруппы7))) Тогда

    Расчет(ГруппаРасчета);

    Условие = НомерИзменяемойКолонки = «4»;

    Условие = Условие ИЛИ НомерИзменяемойКолонки = «4»;

    Условие2 = НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7;

    Условие = Условие ИЛИ Условие2;

    Дешево и сердито, я лично перешел на такой способ.

    Вместо Условие2 лучше писать осмысленный текст, тогда еще и комментирование происходит, например УсловиеГруппыОсобыхРасчетов.

    Reply
  2. tormozit

    (1) В некоторых случаях такой подход действительно оправдан, но в большинстве случаев он излишне повышает «жесткость» логической конструкции.

    Reply
  3. fixin

    (2) зато прозрачно и наглядно.

    Reply
  4. Steelvan

    В языке Дракон удобно визуализировать такие выражения.

    Reply
  5. vlad.frost

    Цель рефакторинга — сделать код более читаемым. А вот это вот «ЕСЛИ Ложь ИЛИ НомерИзменяемойКолонки = «4»» у меня уже выворачивает мозги наизнанку.

    Я бы написал так:

    ВыполнитьРасчетПоНомеруКолонки(ГруппаРасчета, НомерИзменяемойКолонки, мИдГруппы7); // Выделили метод
    
    Процедура ВыполнитьРасчетПоНомеруКолонки(ГруппаРасчета, НомерИзменяемойКолонки, мИдГруппы7)
    
    Если НомерИзменяемойКолонки = «4» Или НомерИзменяемойКолонки = «5» Тогда
    Расчет(ГруппаРасчета);
    Возврат;
    КонецЕсли;
    
    Если ГруппаРасчета <> мИдГруппы7 Тогда // Инвертируем условие
    Возврат;
    КонецЕсли;
    
    Если НомерИзменяемойКолонки = «7» Или НомерИзменяемойКолонки = «8» Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;
    
    КонецПроцедуры;
    

    Показать

    Согласитесь, так читается ещё легче.

    Reply
  6. tormozit

    (5) Возможно проблема только в адаптации мышления к элементарным приемам из булевой алгебры для тех кто с ней не знаком. Истина не меняет результат конъюнкции (ИСТИНА И), и Ложь не меняет результат дизъюнкции (ЛОЖЬ ИЛИ).

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

    Reply
  7. StepanZaytsev

    я конечно не претендую на мнение авторитетное, но не проще ли все делать логическими схемами, еще с курса информтики так все делали, чем придумывать новые схемы?? это как на программировние

    Reply
  8. vlad.frost

    (6) Вот представьте, инженер техподдержки, ему 35 лет. Он булеву алгебру учил двадцать лет назад в школе. У него ещё десять заявок в очереди и злой пользователь на линии. И вот он смотрит на ваш код и пытается понять, что же значит ваше семиэтажное выражение. Каковы шансы, что он легко поймёт, что вы имели ввиду, когда писали этот код?

    Возможно, ваше выражение тождественно первоначальному, но легче читать его не стало.

    Reply
  9. fixin

    (8) полностью согласен. Тормоз, ты нарушаешь принцип KISS.

    Reply
  10. tormozit

    (8), (9)

    Это обычные споры для рефакторинга.

    Выносить ли в отдельную функцию фрагмент кода, который с большой вероятностью будет вызван только в одном месте?

    Оформлять ли в виде отдельной переменной выражение, которое с большой вероятностью будет использовано только в одном месте?

    Выносить ли во временную таблицу пакета подзапрос, который с большой вероятностью будет использован только в одном месте?

    Ответ на такие вопросы (абстаригуясь от специфики запросов к данным) обычно

    — Да, если фрагмент настолько большой или сложный, что затрудняет восприятие/чтение/понимание логики программы.

    — Нет — в остальных случаях, т.к. для человека последовательное с фиксацией промежуточных результатов в виде отдельных переменных чтение программы труднее.

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

    Reply
  11. Rustig

    ТормозАйти, у тебя наверняка есть еще какие-нибудь трюки, способы, личные методики программирования (разработки). Мне интересно и полезно читать как саму идею публикации, так и шлейф комментариев. 🙂 так что просим на бис 🙂

    Reply
  12. software1c

    Плюс автору. За методику ФОРМАТИРОВАНИЯ кода. Однозначно, четко и понятно даже пятикласснику

    Reply
  13. new_user

    Че-т какие-то комментарии неоднозначные! Мне очень приемчик понравился, активно использую его в практике! Автору спасибо!..

    Reply
  14. aspirin4eg

    Применять булеву алгебру, на мой взгляд, следует именно для упрощения логических конструкций и исключения ненужных проверок в условиях. Иначе она несет только усложнение. Восприятие скобок облегчается если их записывать правильно. Тогда кстати и читаемость условий намного упрощается.

    Reply
  15. kalyaka

    Форматирование однозначно повышает читаемость! Убрать бы еще лишние слова «Истина» и «Ложь» и будет вообще отлично.

    Reply
  16. tormozit

    (15) В таком случае ты не сможешь просто закомментировать первое условие в каждой группе и сохранить синтаксическую корректность.

    Reply
  17. Созинов

    За заметку +. Было бы неплохо почитать об улучшении читаемости кода, если есть еще методики, а то недавно свой код годовой давности правил — был в шоке. Да и сейчас зачастую пишу такое, что потом себе руки отрезать хочется 🙂

    Reply
  18. vlad.frost
  19. logarifm

    Мозговынос и не нахожу в таких условиях ничего кроме трудностей их отладки и восприятия. Мое ИМХО — обойтись гораздо проще и более эфективно написав несколько упрощенных условий чем одно но с сумасшедшшей структурой. Не оправдано это… Остаюсь при своем мнении и не ставлю ни плюса ни минуса.

    ЗЫ. охота было влипить минус но остановило лишь то, что автор знает о чем пишет и это труд. А минус за сложность и не рациональное использование таких выражений. (Игра слов)

    Reply
  20. e.kogan

    (19) logarifm, лично мне приятнее читать грамотный и структурированный текст, чем конструкции вроде «Мое ИМХО — обойтись гораздо проще и более эфективно написав несколько упрощенных условий чем одно но с сумасшедшшей структурой. Не оправдано это…»

    //SARCAZM//

    Reply
  21. logarifm

    (20) e.kogan, А в чем не граммотность опридиления условий в простом виде:

    Если Тогда

    Если Тогда

    Если Тогда

    и т.п.

    КонецЕсли;

    Причем здесь конструктивность языка вообще!? Тебе как минимум сюда или наподобие этого:

    читать книги С.Макконнелла «Совершенный код». Вообще не путай статью автора из структурированным кодом!

    Reply
  22. logarifm

    на просторы интернета…. ахахах смешно. Облегчу с поиском:

    И́МХО или ИМХО́ (от англ. IMHO, In My Humble Opinion), также имхо или imho (строчными буквами) — русская транслитерация английского акронима, означающего «по моему́ скромному мнению» .

    Область использования сокращения — эхоконференции, форумы, чаты, и другие (как публичные, так и частные) места для выражения своего отношения к какому-нибудь предмету. В разговорной речи встречается относительно редко.

    Reply
  23. DrAku1a

    (21)

    Если ТипЗнч(Объект)=Тип(«СправочникСсылка.Номенклатура») Тогда
    Если НЕ Объект.Пустая() Тогда
    …
    КонецЕсли
    КонецЕсли;
    
    Reply
  24. YanTsys

    (23) logarifm, думаю проблема не в «ИМХО», а в формулировке «обойтись гораздо проще и эфективно», для того чтобы понять какой смысл вы заложили в предложение попробуйте составить обратное. Как оно будет звучать: «обойтись сложнее и неэффективно»?

    Кроме того:

    «влИпить»,

    «статью автора ИЗ структурированным кодом»,

    «сумасшедшШей»,

    «опрИдИления».

    Ну и на вопрос:

    «А в чем не граммотность опридиления условий в простом виде:

    Если Тогда

    Если Тогда

    Если Тогда

    и т.п.

    КонецЕсли;
    »

    1С при проверке на такой код выдаст ошибку:

    err: Ожидается ключевое слово ‘КонецЕсли’

    Граммотно писать:

    Если Тогда

    ИначеЕсли Тогда

    ИначеЕсли Тогда

    и т.п.

    КонецЕсли;

    И если девушка читала Стива Макконнелла то с вашей стороны будет «наивно» полагать, что она не понимает значение вашего «ИМХО», и проверьте на приборах скромность вашего мнения, лично мне кажется вы его недооцениваете 🙂

    Reply
  25. logarifm

    Ой, а я просто и не знал, что там ошибка, а еще ошибка в том что в условиях нет логических выражений и что?

    Reply
  26. borda4ev

    А как же ?(Условие, истина, Ложь), на наглядно?

    Так же для простоты и наглядности можно использовать соответствие, то есть заводить несколько вариантов, а потом небольшим условием его обходить.

    Reply
  27. ЧИА

    не буду придираться к коду

    придерусь к идее

    как приверженец написания кода через отладчик, считаю, что

    1. условия должны быть простыми

    2. везде должно быть место точке останова

    таким образом, надо писать не одну дикую проверку

    и не структуру типа

    Если Тогда

    ИначеЕсли Тогда

    ИначеЕсли Тогда

    КонецЕсли;

    а структуру типа

    Если Тогда

    Если Тогда

    Иначе

    КонецЕсли;

    Иначе

    Если Тогда

    Иначе

    КонецЕсли;

    КонецЕсли;

    Reply
  28. tormozit

    (28) Чтобы было более наглядно, приведи свой вариант кода для примера из статьи.

    Reply
  29. ЧИА
    НадоСчитать = Ложь;
    
    Если ГруппаРасчета = мИдГруппы7 Тогда
    
    Если (НомерИзменяемойКолонки = «8») Тогда
    НадоСчитать = Истина;
    Иначе
    //
    КонецЕсли;
    
    Иначе
    
    Если
    (НомерИзменяемойКолонки = «7»)
    Или
    (НомерИзменяемойКолонки = «4»)
    Или
    (НомерИзменяемойКолонки = «5»)
    Тогда
    НадоСчитать = Истина;
    Иначе
    //
    КонецЕсли;
    
    КонецЕсли;
    
    Если НадоСчитать  Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;
    
    

    Показать

    Reply
  30. ЧИА

    по тем же причинам

    запросы рекомендую писать не через вложенные

    а через временные таблицы

    и отлаживать проще

    и нагляднее

    и быстрее обычно выполняется

    Reply
  31. tormozit

    (30) Сразу видно дублирование кода «Расчет(ГруппаРасчета);». Подумай что будет, если там не одна строка будет, а 30 например =)

    Reply
  32. ЧИА

    (32)

    что будет, если там не одна строка будет, а 30 например

    если в блоке больше 8 строк (требования моих наставников), ну или 16 (один экран, мои), это или процедура, или функция

    переделал с одним запуском

    Reply
  33. -fox-

    По мне, если условие сложное, его всегда можно разбить на более простые + сделать грамотные комментарии.

    Reply
  34. lesenoklenok

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

    Reply
  35. poyson

    Чтоб понять надо вникнуть :). В целом интересный подход. Спасибо.

    Reply
  36. Пан

    любая структуризация полезна, спасибо

    Reply
  37. xFoG

    (30) ЧИА,

    таким образом, надо писать не одну дикую проверку

    и не структуру типа

    Если Тогда

    ИначеЕсли Тогда

    ИначеЕсли Тогда

    КонецЕсли;

    а структуру типа

    Если Тогда

    Если Тогда

    Иначе

    КонецЕсли;

    Показать

    В первом случае после получения истины мы остальные проверки не проводим, во втором — проверяем все, что увеличивает время выполнения участка кода.

    (31) ЧИА,

    запросы рекомендую писать не через вложенные

    а через временные таблицы

    и отлаживать проще

    и нагляднее

    Простота отладки сомнительна. Скопировать текст вложенного запроса в консоль проще.

    (33) ЧИА

    если в блоке больше 8 строк (требования моих наставников), ну или 16 (один экран, мои), это или процедура, или функция

    Всегда считал, что единственным условием является множественность использования блока, а не размер. Каким же шрифтом вы пишите, что у вас 16 строк на экран умещается?

    Reply
  38. su_mai

    (1) А я думал, что он это ты :), ошибся :)))

    Reply
  39. su_mai

    (10) Все неверно! Читай про процедурную декомпозицию кода: https://ru.wikipedia.org/wiki/%D0%94%D0%B5%D0%BA%D0%BE%D0%BC%D0%BF%D0%BE%D0%B7%D0­%B8%D1%86%D0%B8%D1%8F.

    Reply
  40. YouName

    Мне этот метод понравился! Возьму на вооружение.

    По мне любой метод найдёт своего «пользователя».

    Reply
  41. palsergeich

    Это как стенография, овладевшим все понятно, но конкретно меня количество скобочек еще никогда не смущало, а вот такая запись нормально прочиталась с 5го раза и не факт что другое выражение я прочитаю с 1ой попытки.

    Метод интересный, но увы, мне за такое оторвут пальцы.

    Просто показал товарищу конечное выражение, он мне в ответ скинул картинку, как он это видит.



    Таки код должен быстро читаться не только Вами но и другими. А стандартное написание подразумевает запись в исходном виде.

    Reply
  42. CagoBHuK

    (21) logarifm, внутри каждого Если придется повторять один и тот же код.

    Reply
  43. Kiber_

    По поводу группировки логических выражений в блоки на основе «одинаковых логических операций» — целиком согласен с автором.

    Но как-то показался очень сложным процесс раскрытия скобок.

    Также не понравились «Ложь» и «Истина» в качестве первого операнда блока.

    Сам-бы написал так:

    Если НомерИзменяемойКолонки = «4»
    Или НомерИзменяемойКолонки = «5»
    Или НомерИзменяемойКолонки = «7»
    Или (НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7) Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;
    Reply
  44. tormozit

    (44) Так плохо отличим конец условия от начала кода под условием.

    Reply
  45. dyuha

    У этого метода два офигенных плюса:

    Можно быстро закомментировать любое условие;

    При отладке и точку останова можно поставить в любом месте, и шагать по F10/F11 удобней.

    Reply
  46. Spec1c82

    Сначала глянул только исходное условие и конечный результат. Сразу не понял зачем нужны «Если Ложь ИЛИ» и «Если Истина И». Пришлось прочитать полностью и после осмысления понял всю красоту предлагаемого решения.

    Очень наглядно было сравнение с отбором настроек компоновки данных.

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

    Впрочем порой красоту структуры в целях оптимизации придется нарушить и в первую очередь проверять наиболее вероятные условия (если есть такое понимание или статистика).

    Reply
  47. vvirus

    Красивый подход ,

    использую такой вариант записи

    (+) при переходе на динамические условия «открытый» ИЛИ не блокирует дополнительные условия

    (+) сохраняеться история введения ограничений

    (-) читаеться возможно сложнее чем вариант топик стартера

    Если (

    (НомерИзменяемойКолонки = «4»)

    Или (НомерИзменяемойКолонки = «5»)

    )

    Или (

    (

    (НомерИзменяемойКолонки = «7»)

    Или (НомерИзменяемойКолонки = «8»)

    И (ГруппаРасчета = мИдГруппы7)

    )

    )

    Тогда

    Расчет(ГруппаРасчета);

    КонецЕсли;

    но и это у меня не оптимизация, а лёгкое упрощение чтения

    если за оптимизацию то необходимость расчёта ожидается в свойствах колонки и(или) в свойствах группы

    то есть …

    Если ( ТекИзменяемаяКолонка.Рассчет ИЛИ ТекГруппаРасчета.Рассчет )

    Тогда Расчет(ТекГруппаРасчета);

    КонецЕсли;

    Разумеется группа условий содержащая ИЛИ всегда в скобках

    Reply
  48. Yashazz

    Уникально редкий случай, когда я склонен согласиться с fixin’ом. Сложную логику надо не переписывать так, этак и разэдак, а упрощать. Реальным упрощением является грамотное использование промежуточных переменных, это и отлаживать легче.

    Reply
  49. tormozit

    (49) Ну это тот же холивар «алгоритмическое или декларативное», «пакет из 10 запросов или один сложный запрос». Я показал для тех, кто предпочитает декларативный стиль, как на мой взгляд оптимальнее оформлять такие выражения. Любители алгоритмического стиля могут конечно результат каждой логической операции помещать в отдельную переменную и давать ей семантически качественное имя =), но это тоже крайность. Так что хороший разработчик должен уметь грамотно сочетать эти подходы и не «холиварить».

    Reply
  50. NittenRenegade

    В начале мне запись не понравилась, т.к. и исходную я прочитал совершенно без труда. В отличие от вариантов людей, предлагавших разбивать на какие-то вызываемые части.

    Однако после комментария software1c вернулся к получившейся записи и понял её. Действительно, для сложных условий запись отличная.

    Reply
  51. Гость

    Интересная статья + нашел для себя несколько интересных способов оформления в комментариях.

    Вывод:

    + Не приветствуются собственные велосипеды (Если Ложь Или…)

    + Условие 1го уровня — 1 таб, 2го уровня 2 таб и т.д. для читабельности

    + Одно условие = одна строка, для возможности быстро закомментировать

    Если
    НомерИзменяемойКолонки = «4» Или
    НомерИзменяемойКолонки = «5» Или
    НомерИзменяемойКолонки = «7» Или
    ( НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7 )
    Тогда
    // …
    КонецЕсли;
    

    Показать

    Reply
  52. xFoG

    (52) HardCoder,

    Только «ИЛИ» в твоем примере хорошо бы писать перед тем выражением, к которому оно относится. Как и запятые и т.д.

    Тогда, удалив или закомментив строку, ты не пролучишь ругань на лишнее «ИЛИ».

    Reply
  53. grumagargler

    а почему просто не убрать лишние скобки?

     Если (НомерИзменяемойКолонки = «4»
    Или НомерИзменяемойКолонки = «5»
    Или НомерИзменяемойКолонки = «7»)
    Или (НомерИзменяемойКолонки = «8»
    И ГруппаРасчета = мИдГруппы7) Тогда
    //…
    КонецЕсли;
    

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

    А если нужен идентификатор из трех слов, то значит сам контекст уже кандидат на рефактор и разбиение на более мелкие функции.

    Reply
  54. Nykyanen

    За часть про оформление (+) за часть про Рефакторинг (-).

    Ведь даже школьник знает что выражения типа: А или Б или В = не (не А и не Б и не В)

    Решать такой пример легче и человеку и машине, так как при использовании только И без ИЛИ и получении первой ложь все выражение в скобках будет ложь.

    Особенно это важно в запросах. Так как ИЛИ в секции ГДЕ запроса при выполнении выполнит два запроса с каждым из условий и сделает их объединение.

    Вывод идем учить преобразования логических выражений, кто ещё не в курсе что это такое.

    Reply
  55. tormozit

    (55) Nykyanen,

    Ведь даже школьник знает что выражения типа: А или Б или В = не (не А и не Б и не В)

    Судя по комментам здесь, это ошибочное утверждение. Не уверен, что мысль твою про рефакторинг я понял. Ты предлагаешь вообще не использовать оператор ИЛИ что ли? Если так то почему он есть во всех языках, раз он такой вредный и избыточный?

    Reply
  56. Nykyanen

    (56) Цель рефакторинга — сделать код программы легче для понимания. В основе рефакторинга лежит последовательность небольших эквивалентных (то есть сохраняющих поведение) преобразований.

    Я хотел добавить, что выполнив логические преобразования выражений можно упростить понимание и так же часто получается повысить скорость работы. Согласен, что не всегда замена всех ИЛИ на И упростит запись и понимание, но на моей практике в 80% случаев замена ИЛИ на И упрощает понимание. Так же в процессе логические преобразования оказывается, что некоторые из выражений не влияют на результат всего выражения и/или можно сократить повторяющиеся выражения.

    Конечно ИЛИ имеет право на жизнь как и много чего другого. Тут как с сортировкой можно в лоб сортировать, а можно пузырьком или еще каким то более хитрым методом.

    Вот пример преобразования выражения из статьи.

    ((НомерИзменяемойКолонки = «4») Или (НомерИзменяемойКолонки = «5»))

    Или (((НомерИзменяемойКолонки = «7») Или (НомерИзменяемойКолонки = «8»)

    И (ГруппаРасчета = мИдГруппы7))) | {замена на буквы по порядку на АБВГД} |

    (А ИЛИ Б) ИЛИ (В ИЛИ (Г И Д)) =

    А ИЛИ Б ИЛИ В ИЛИ (Г И Д) =

    НЕ(НЕ А И НЕ Б И НЕ В И НЕ(Г И Д)) =

    НЕ(НЕ(НомерИзменяемойКолонки = «4») И НЕ(НомерИзменяемойКолонки = «5») И НЕ(НомерИзменяемойКолонки = «7») И НЕ((НомерИзменяемойКолонки = «8») И (ГруппаРасчета = мИдГруппы7))) =

    НЕ(НомерИзменяемойКолонки <> «4»

    И НомерИзменяемойКолонки <> «5»

    И НомерИзменяемойКолонки <> «7»

    И НЕ((НомерИзменяемойКолонки = «8») И (ГруппаРасчета = мИдГруппы7)))


    Так как в скобках все через И а за скобками НЕ, тогда если хотя бы одно выражение равно ЛОЖЬ в скобках, тогда и все выражение в скобках равно ЛОЖЬ, а все выражение равно ИСТИНА. Пример, НомерИзменяемойКолонки = 5, тогда все выражение в скобках равно ложь, а все выражение равно истина.

    Reply
  57. e-sin

    (54) grumagargler,

    Лучше совсем убрать.

    Если НомерИзменяемойКолонки = «4»
    Или НомерИзменяемойКолонки = «5»
    Или НомерИзменяемойКолонки = «7»
    Или НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7 Тогда
    //…
    КонецЕсли;
    
    Reply
  58. maks_20

    Пользуюсь такой методикой. Солидарен с автором — удобно, наглядно, читабельно. Стоит один раз понять всю логику и потом уже проблем не будет.

    Reply
  59. lunjio

    книга «Совершенный код», совет автора — объединять такие условия в логически понятные группы, вместо НомерИзменяемойКолонки = «4» вынести предварительно в отдельную переменную и писать ПользовательМеняетКолонкуЦена = НомерИзменяемойКолонки = «4», а в условиях уже будет Если ПользовательМеняетКолонкуЦена ИЛИ ПользовательМеняетКолонкуСумма и т.д, сейчас такие процессоры, что нужно идти в сторону удобночитаемости кода, и не заморачиваться на том, что выполнится пару лишних условий в жертву удобночитаемости и логического смысла кода.

    Reply
  60. Юрий-К

    Давно делаю как Сергей, еще с Дельфи осталась такая традиция,

    также «привил» себе привычку скобки подряд не ставить — «((«, или разреживать скобки пробелами » ( ( » или разносить на разные строки, читаемость повышается.

    пример

    было  Если ((НомерИзменяемойКолонки = «4») Или (НомерИзменяемойКолонки = «5»))
    
    Стало Если (
    (НомерИзменяемойКолонки = «4») Или (НомерИзменяемойКолонки = «5»)
    )
    
    Reply
  61. spacecraft

    (61) для меня более читабелен первый вариант.

    Второй размазанный по странице получается. А если учитывать, что в нем блок кода еще, то на страницу может не поместиться. Тогда совсем не читабельно получается.

    Reply
  62. romasna

    Мне нравятся такие штучки, улучшающие обзор кода. Всегда отдавал предпочтение структуре логического выражения

    Если <Начало условия >
    <Продолжение условия>
    Тогда
    <Блок операторов>
    КонецЕсли
    

    А из этой статьи узнал еще о некоторых простых приемах, улучшающих понимание сложных выражений. Спасибо автору.

    Вот только одна незадача: фирма 1С не приветствует такое структурирование логического выражения и после авто-форматирования блока программного кода вся наша красотища превращается в (на примере автора статьи)

    Если Ложь
    Или НомерИзменяемойКолонки = «4»
    Или НомерИзменяемойКолонки = «5»
    Или НомерИзменяемойКолонки = «7»
    Или (Истина
    И НомерИзменяемойКолонки = «8»
    И ГруппаРасчета = мИдГруппы7)
    Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;
    

    Показать

    Меня всегда раздражало это маленькое недоразумение… 🙂

    Reply
  63. www2000

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

    Reply
  64. tormozit

    Конструктор запроса из подсистемы «Инструменты разработчика» теперь по умолчанию использует описанный в статье иерархический стиль (и-или дерево) сборки условий отбора и соединений.

    Reply
  65. inf012

    (1)

    Условие = НомерИзменяемойКолонки = «4»;

    Условие = Условие ИЛИ НомерИзменяемойКолонки = «4»;

    Условие2 = НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7;

    Условие = Условие ИЛИ Условие2;

    А что это за конструкция такая с несколькими равно в строке, не встречал ее в типовых конфах?

    Как ее правильно читать, где написано?

    Reply
  66. Release

    Левой переменной присваивается результат сравнения: Результат = (ПервоеЗначение = ВтороеЗначение), подобно: Результат = ПервоеЗначение <> ВтороеЗначение или Условие2 = НомерИзменяемойКолонки <> «8».

    Reply
  67. binx

    На мой взгляд если много условий,то это не очень хорошо и плохо читаемо в любом случае как не форматируй.

    Reply
  68. slawa

    Чем больше пользуюсь — тем больше позитива от этого метода.

    Попробуйте.

    Например:

    Для каждого эл Из Объект.Товары Цикл
    Если Ложь
    ИЛИ (Истина
    И ИспользуетсяОСНО
    И эл.СчетУчета = ПланыСчетов.Хозрасчетный.ИнвентарьИХозяйственныеПринадлежностиВЭксплуатации)  // МЦ.04
    ИЛИ (Истина
    И ИспользуетсяОСНО
    И эл.СчетУчета.Родитель = ПланыСчетов.Хозрасчетный.Материалы // 10
    И эл.СчетУчета.ВидыСубконто.Найти(ПланыВидовХарактеристик.ВидыСубконтоХозрасчетные.Склады) <> Неопределено)
    Тогда
    НужноСоздатьПоступлениеМЦ = Истина;
    Иначе
    НужноСоздатьПоступлениеМЦ = Ложь;
    Прервать;
    КонецЕсли;
    КонецЦикла;
    

    Показать

    Reply
  69. tormozit

    (70) Да, ты один смог так ошибиться. Проверь что выдаст оригинал и что выдаст твой вариант при НомерИзменяемойКолонки = «7» и ГруппаРасчета <> мИдГруппы7 . Их поведение будет различным. Обрати внимание на приоритеты логических операций. А ИЛИ Б И В эквивалентно А ИЛИ (Б И В), а не (А ИЛИ Б) И В.

    Reply
  70. tormozit

    (72) Научиться признавать ошибки — непростая задача. Я помогу тебе.

    Reply
  71. slawa

    А так сдвинуть лидирующий Истина или Ложь

    Тоже вроде ничего и в глаза не бросается

    Если         Ложь
    ИЛИ СС_ТемаЗадание.СоздатьСчетНаОплату
    ИЛИ СС_ТемаЗадание.СоздатьКП
    ИЛИ СС_ТемаЗадание.СоздатьДоговор
    Тогда
    ….
    
    Reply
  72. SiAl

    (66) Переменная в 1С версии 8 может быть булевой переменной. А потому самый левый знак равно — это знак присваивания, а все дальнейшие знаки равно — это знаки сравнения.

    Reply
  73. KlesAlex

    С таким количеством скобок и сравнений не часто сталкиваюсь.

    Но из похожего — различные заполнения свойств через равенство оформляю по принципу чтобы знак равенства был в одном месте.

    Например

    НоваяЗапись_____ =_____ПеременнаяТаблицы.Добавить();

    НоваяЗапись.а1___=_____ПолучитьА1();

    НоваяЗапись.Упр__=_____ПолучитьУпр();

    Reply
  74. herfis

    1) Выносить «Тогда» на отдельную строку в сложных условиях мне тоже казалось нагляднее и удобнее.

    Но плюнул в итоге, т.к. противоречит стайл-гайдам 1С и автоформатирование конфигуратора тоже его не любит (корежит при рефакторинге)

    2) заменять первое условие на Истина/Ложь для удобства рефакторинга тоже неоднозначный вариант. Тасовать при рефакторинге чуть удобнее и быстрее, но опять-таки больше авторский стиль получается. А я стараюсь писать так, чтобы левому человеку код глаз не резал. И ценю такой же чужой код.

    А в сухом остатке получается просто грамотное составление логических выражений и оформление их по одинэсовскому стайл-гайду.

    Reply
  75. tormozit

    (76) Такое оформление кода я лично не использую и считаю его больше вредным чем полезным, т.к. редактированию оно сильно мешает. А вот читать такой код конечно приятнее. В идеале конечно хочется 2 режима просмотра кода — для чтения и для редактирования — с быстрым переключением между ними. Тогда такое оформление будет приносить больше пользы чем вреда.

    Reply
  76. nvv1970

    За собой и за другими замечал в своё время — у новичков есть желание усложнить условия, объединить их в одно, написать их сложно. Это как бы показывает уровень.

    Более опытные стараются дробить на отдельные конструкции, чтобы при отладке понимание причин того или иного результата условия не занимало больше 0 секунд. Есть 10 составляющих условия — в идеале столько же веток выполнения.

    На практике конечно нужна золотая середина. Но мой посыл: УПРОЩЕНИЕ — наше все, но без фанатизма.

    Пс: от паразитных ложь и истина однозначно коробит.

    Reply
  77. vlad.frost
  78. tormozit

    (80) Тоже просто процитирую это здесь

    Объединение условных операторов

    Проблема: У вас есть несколько условных операторов, ведущих к одинаковому результату или действию.

    Решение: Объедините все условия в одном условном операторе.
    Reply
  79. tormozit

    Добавил в статью по одному плюсу и минусу

    + сокращает левые отступы, вложенность условий, количество строк в коде по сравнению с другими удобочитаемыми стилями

    — автоформатирование кода выравнивает все строки условия по одной границе

    Reply
  80. klinval
    Reply
  81. tormozit

    (83) Если есть время, желание и условие пишется с нуля либо полностью понятно, то так писать конечно в целом лучше. Однако строк получится заметно больше и вероятность внести ошибку выше. Также для не с нуля написанного выражения придется досконально разобраться во всех деталях условия, чтобы не испортить его восприятие привнесенной семантикой новых переменных. Мой же способ позволяет рефакторить и оформлять даже вообще непонятные условия с минимальным риском повреждения их логической и без риска повреждения семантической структуры.

    Reply
  82. Vortigaunt

    Cам пришел к чему-то аналогичному.

    Сначала длиннные условия у меня перестали влезать в одну строку на мониторе, поэтому разбил их переносами.

    Плюс при сравнении / объединении сразу видно в какой части условия изменение.

    А потом до меня дошло, что скобочки в сложных условиях это почти то же самое, что и фигурные скобки, например, в java. И если написание кода в 1 строчку — это плохо и рекомендуется форматировать код оступами, то почему нельзя также форматировать сложные вложенные условия?

    Reply
  83. kalyaka

    (16)Перечитал еще раз, идея понравилась 🙂

    Reply
  84. tormozit

    (86) Лучше поздно, чем никогда =)

    Reply
  85. ManyakRus

    вместо Истина надо писать 1=1

    Ложь: 0=1

    Я во всех запросах пишу:

    ГДЕ 1=1

    🙂

    Reply
  86. VitaliyCeban

    Не в огорчение сказано, но на ум приходят только три слова: «адъ и израиль». Бедные мои глаза.

    Код из шапки я бы написал следующим образом:

    Если НомерИзменяемойКолонки = «4»
    ИЛИ НомерИзменяемойКолонки = «5»
    ИЛИ НомерИзменяемойКолонки = «7»
    ИЛИ НомерИзменяемойКолонки = «8» И ГруппаРасчета = мИдГруппы7 Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;
    

    Минусы по сравнению с подходом автора: Нужно вручную выравнивать пробелами.

    Плюсы: Отличная читаемость.

    По аналогии с индексами в СУБД: наличие индекса увеличивает время записи, но последующие чтения выполняются существенно быстрее. Так и тут, лучше один раз «дольше» написать, но потом чтобы не было больно глазам и стыдно за свой код.

    Reply
  87. acsent

    нужно бы и скобочку последнюю переносить

    Если Ложь
    Или НомерИзменяемойКолонки = «4»
    Или НомерИзменяемойКолонки = «5»
    Или НомерИзменяемойКолонки = «7»
    Или ( Истина
    И НомерИзменяемойКолонки = «8»
    И ГруппаРасчета = мИдГруппы7
    ) // Эту скобочку тоже переносим если нужно будет закомментировать
    Тогда

    Показать

    Reply
  88. tormozit

    (91) Пробовал так, но получается слишком много почти пустых строк (по количеству закрывающих скобок). Тут минусы для меня перевесили плюсы. Однако когда возникает потребность закомментировать последнее условие группы, я делаю именно так, но временно.

    Reply
  89. rpgshnik

    (91)

     Если ЛОЖЬ
    ИЛИ НомерИзменяемойКолонки = «4»
    ИЛИ НомерИзменяемойКолонки = «5»
    ИЛИ НомерИзменяемойКолонки = «7»
    ИЛИ (ИСТИНА
    И НомерИзменяемойКолонки = «8»
    И ГруппаРасчета = мИдГруппы7)  //нормально комментируется
    Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;

    Показать

    Reply
  90. rpgshnik

    В результате форматирования будет выглядить всё так:

     Если ЛОЖЬ
    ИЛИ НомерИзменяемойКолонки = «4»
    ИЛИ НомерИзменяемойКолонки = «5»
    ИЛИ НомерИзменяемойКолонки = «7»
    ИЛИ (ИСТИНА
    И НомерИзменяемойКолонки = «8»
    И ГруппаРасчета = мИдГруппы7)
    Тогда
    Расчет(ГруппаРасчета);
    КонецЕсли;

    Показать

    Неоднозначный подход конечно, вроде бы интересно, но в то же время смущают эти ЛОЖЬ ИЛИ и ИСТИНА И, возможно попробую методику. Но в начальном примере реально было жутко много скобок, которые можно было просто убрать и облегчить читабельность)))

    Reply
  91. acsent

    Вообще первичное удаление скобочек называется: приведение к дизъюнктивной нормальной форме

    Reply
  92. acsent

    (92) Те первую истину писать не влом, а вот 2ю скобочку переносить влом.

    А можно ведь и вторую истину писать ))

    ИЛИ (ИСТИНА

    И НомерИзменяемойКолонки = «8»

    И ГруппаРасчета = мИдГруппы7

    И ИСТИНА)

    Reply
  93. tormozit

    (96) Где я писал что мне «в лом»? Я писал «слишком много почти пустых строк».

    Reply
  94. IntelInside

    Сложные и многоэтажные логические конструкции сложны для понимания. Это зло профессии и не нужно их дополнительно усложнять. Их надо нещадно рефакторить и сводить к простым. Правдо это долго.

    Фактически Вы сводите логическую конструкцию к легко читаемому виду, где в начале каждой строки стоит условие.

    Для И получается легко читаемое на одном дыхании ЕСЛИ ИСТИНА-И-Условие_а-И-Условие_б. Но для ИЛИ получается ересь читаемая как ЕСЛИ ЛОЖЬ-ИЛИ-Условие_а-ИЛИ-Условие_б.

    По моему, если условие не очень многоэтажное, то оно и так может читаться при хорошем форматировании. А если условие строк эдак на 15-20, то его Ваша форма только дополнительно усложнит. Его надо рефакторить.

    ПС. Спасибо за мысль. а) буду делать дополнительные оптимизации к своему компилятору. б) при расширении грамматики подумаю над возможностью опустить первый операнд ИИЛИ: ЕСЛИ И Условие_а И Условие_б; ЕСЛИ ИЛИ Условие_а ИЛИ Условие_б.

    ППС. Можно завести себе для красоты константы или пока функции:

    (Фантазии, перспектива)

    Конст ИстинаЛюбое = Ложь ЭКСПОРТ

    Конст ИстинаКаждое = Истина ЭКСПОРТ



    ЕСЛИ ИстинаЛюбое

    ИЛИ Условие_а

    ИЛИ Условие_б

    ЕСЛИ ИстинаКаждое

    И Условие_а

    И Условие_б

    Reply
  95. ger_kar

    (8) Мне 42 года, в процессе программирования (не только 1С) булеву алгебру использую постоянно. Конкретно для меня семиэтажное выражение более наглядно и понятно и проще для восприятия. Про других не знаю. И вообще вопрос восприятия он очень субъективен. Но странный должно быть инженер, который выучил алгебру 20 лет назад, потом 20 лет с ней не сталкивался и тут на тебе 🙂

    Reply
  96. ger_kar

    (13) Так и должно быть, ибо это вопрос восприятия, а он очень и очень субъективен.

    Reply

Leave a Comment

Ваш адрес email не будет опубликован. Обязательные поля помечены *