tech.Solbi

Рабочие заметки программисту 1С (как правильно программировать и оформлять разработки и как не нужно программировать)

Подмена понятий при назывании переменных, реквизитов, процедур, функций и т.д….

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

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

Возможные варианта подмены понятий:

  1. Абстрагирование (когда назначается абстрактное имя. Например что-то типа «ALFA01»)
  2. Сокращение наименования и аббревиатуры (Примеры: РеализТовУсл, РТУ)
  3. Ложное назначение имени (когда присваиваемое имя прямо противоречит сути объекта)
    Например ОТОБРАЗИТЬ

Последствия применения подмены понятий:

  1. В случае абстрагирования — никаких особых неприятностей ждать не приходиться, ну кроме как усложнения читабельности..
    Не нужно усложнять то (программный код), что итак может быть не просто!
  2. В случае сокращения наименований и применений аббревиатуры предпочтительно использовать сокращения, а не аббревиатуры. Это связано с тем, что количество объектов конфигурации, которые при применении аббревиатур очень велико (например: «ВверхПоСписку» и «ВыпискаПоСотруднику» будут иметь одинаковую аббревиатуру ВПС).
    Не нужно применять аббревиатуры для наименований, т.к. это приводит к тому что теряется уникальность имени и на подсознательном уровне программист может принять желаемое за действительное!

    Однако при применении сокращений нужно внимательно анализировать, что-же за имена получаются при применении сокращений (например: «Кредитная линия» можно сократить до «КЛин»). Обязательно нужно проверять, чтобы получившиеся имена не превращали имя в ложное название объекта (именно так может происходить с примером КЛин, в том случае если произойдет пересечение предметных областей работающих с кредитными линиями и клиньями 😉 ).

    Правильное применение сокращений и полных наименований сущностней объектов конфигурации — по сути это то, что превращает программный текст в удобочитаемый и понятный код!
  3. Ложное назначение имени — это один из самых плохих приемов программирования.
    Никогда! Не используете этот приём программирования!

    Причина как всегда кроется не в том, что программный код будет работать сразу не правильно (при первичной разработке программист может позаботиться чтобы система работала правильно), а в том, что при возникновении необходимости по доработке или использования ранее написанного кода в котором произведено ложное назначение имени, программист (хоть тот кто писал код изначально, хоть другой) просто не вспомнят и не подумаю что «вот этот объект», с таким именем на самом деле означает совершенно другое! И будут они считать что сумма — это сумма, а это на самом деле цена!



Один комментарий

Добавить комментарий

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