1.
Название статьи обыгрывает известное название книги Steve McConnell «Code complete». Статья отличается от множества других статей на подобную тему: текста не видно, а картинки все время двигаются. Директор нашего департамента утверждает, что сейчас среди людей преобладает клиповое мышление. Посмотрим, насколько эта статья приглянется читателям.
Первый клип посвящен объектному чтению. Это действительно очень плохой стиль программирования. Но есть хорошие новости: я научился находить в технологическом журнале все случаи объектного чтения, которые мешают работе программы. Такие запросы используют ключевые слова SELECT…Version. Запросы, которые пишут программисты, версию объекта не используют. Подробнее — infostart.ru/public/825405.
2.
Второй клип – пожалуйста используйте форматирование. Кроме волшебных клавиш Shitf+Alt+F пригодится сочетание Shift+Tab сдвигать влево текст запросов, созданных конструктором. Если текст запроса формируется динамически, изменяется — пожалуйста, сделайте чтобы его можно было открывать конструктором для просмотра и проверок ошибок.
Синтаксические ошибки в коде программы – также как в деловой переписке свидетельствуют о незаинтересованности корреспондента. Кстати, S. McConnell глава «Форматирование и стиль», основные тезисы:
- Зрительное и интеллектуальное наслаждение, получаемое от хорошо отформатированного кода, — удовольствие, которое способны оценить лишь немногие непрограммисты
- Основная теорема форматирования гласит, что хорошее визуальное форматирование показывает логическую структуру программы
- В сложных логических выражениях размещайте каждое условие на отдельной строке
- Избегайте операторов goto
- Длина строки выражения не должна превышать 80 символов (В современной 1С – 120 )
- Используйте пробелы около скобок ( () ), чтобы сделать читаемыми логические выражения
- Что делать с частью выражения, переносимой на следующую строку
- Не выравнивайте правые части выражений присваивания (Сейчас нет единой позиции по этому вопросу. Но мне импонирует Code complete)
- Размещение каждого оператора на отдельной строке
Кроме этого, метаданные (Справочники, Документы, Регистры…) в дереве необходимо сортировать. Так гораздо аккуратнее. Реквизиты объектов можно оставить без сортировки. Исключение: нельзя сортировать подписки на события !! Потому что порядок выполнения подписок зависит от их положения в дереве метаданных, см //infostart.ru/public/554424/. Самая плохая идея — сортировать реквизиты регистров сведения (накопления).
3.
Третий клип. Константу использовал для примера. Уверен, что Вы сможете придумать более элегантный способ избежать хардкодинга.
Чтобы вы правильно понимали, из двадцати лет работы программистом, восемнадцать лет я использовал короткие, неинформативные имена переменных. Потребовался толчок (Доброе слово и пистолет), чтобы я начал задумываться об их именах. Кстати, S. McConnell глава «Сила имен переменных», основные тезисы:
- Имя должно полно и точно описывать сущность, представляемую переменной.
- Аббревиатуры, сокращения нежелательны (ниже идет список рекомендованных сокращений).
- Короткое имя означает, что переменная будет использоваться в одной-двух строках. Многие опытные программисты вообще не используют имена вроде i.
- Чем шире область применения переменной, тем имя должно быть длиннее.
- Префикс — тип переменной в имени можно указывать или нет (По стандартам 1С ИТС – нет)
Именам функции (процедуры) посвящен раздел https://its.1c.ru/db/v8std#content:647:hdoc. Если вкратце, имена не должны содержать префикс или иной намек на возвращаемый тип данных, аргументы функции (процедуры) при возможности сохранять в структуре значений, которая будет единственным аргументом, наименование функции (процедуры) должно быть настолько информативным, чтобы не было нужды в дополнительном комментарии. Кстати, S. McConnell глава «Самодокументирующийся код», основные тезисы:
- Задача документирования … во многом решается за счет хорошего стиля программирования (правильные имена переменных и функций).
- Комментарии иногда полезны, иногда — нет (перечислены случаи pro et contra. И это не намек на популярную игру, а обычная латынь. Не латунь, а латынь.)
- Не комментируйте хитрый код — перепишите его
В последнее время из имени стали убирать часто-используемое слово «Получить».
В планах – добавить клип про создание форм пользовательских интерфейсов. Пока перечислю основные тезисы:
- Рекомендуется для всех форм самостоятельно настраивать расположение реквизитов, их растягивание (по умолчанию реквизиты не должны растягиваться по горизонтали), расположение и выравнивание.
- Автоматическое расположение реквизитов допускается для форм простейших объектов (например, справочник из Наименование + Код)
- Форма для отчетов на основе СКД как правило используется из дерева метаданных Общие формы -ФормаОтчета. Это принесет дополнительные бонусы: регистрация в замерах производительности, аккуратный выбор периода отчета, стандартное редактирование настроек, обработчики реквизитов формы. В случае, если необходимо внести изменения, копируем форму из дерева метаданных общие формы в отчет, назначаем основной и изменяем.
- Для ПолныхПравПрограммистов всегда должны быть доступность и видимость всех реквизитов, если задача не подразумевает обратное. Исключение составляет реквизит номер.
- Все реквизиты шапки размещаются согласно стандартам разработки 1С Стандарт 1С: Командная панель формы документа.
- Синоним поля Дата назначается «от». Длина поля Дата 14 символов.
- Ширина поля Номер определяется, исходя из длины номера экспериментальным путём – так, чтобы все цифры помещались в поле, и при этом не было пустого пространства.
- Итоги документов размещаются согласно стандартам разработки 1С Стандарт 1С: Итоги в документах. Рекомендуется использовать стандарт в качестве образца расположения. Цветовое решение может отличаться, ввиду того, что используется другой интерфейс. За основу можно взять следующее оформление (цвет фона Web Дымчато-белый)
- В свойствах всех реквизитов шапки необходимо снимать признак Растягивать по горизонтали. При необходимости задания ширины элементов, отличной от сформированной платформой, задать значение вручную.
- Для всех документов, которые будут создаваться пользователями в количестве, большем нескольких штук, по умолчанию добавлять комментарий и автора (Ответственный). Ответственный или автор – определяется программистом самостоятельно, в зависимости от конкретной задачи. Оформление реквизитов выполняется в соответствии со стандартом Стандарт 1С: Поля Ответственный и Комментарий. В отличие от реквизитов шапки, поле комментарий может иметь признак Растягивать по горизонтали.
- Модули форм оформляются через области, используя стандартные и, при необходимости, свои.
#Область ОбработчикиСобытийФормы
#КонецОбласти
#Область ОбработчикиСобытийЭлементовФормы
#КонецОбласти
#Область ОбработчикиСобытийЭлементовФормыНаСервере
#КонецОбласти
#Область ОбработчикиКоманд
#КонецОбласти
#Область СлужебныеПроцедурыИФункции
#КонецОбласти
Отдаю себе отчет, что тема хорошего кода – высокохоливарная, поэтому конструктивные комментарии приветствуются, поощряются SM и включаются в статью. Заранее спасибо.
P.S.
Порядок комментирования программного кода и изменений
1. Помещение в хранилище изменений
Любые изменения, помещаемые в хранилище, должны сопровождаться комментарием с произвольным описанием вносимых в хранилище изменений.
Пример описания вносимых изменений:
1.1. Добавлен отчёт ПРЕФИКС_Продажи
1.2. В типовой документ ПТиУ добавлен реквизит «ПРЕФИКС_Акция» и его обработка в модулях.
2. Добавление Нового функционала
Новые процедуры/функции, блоки кода должны сопровождаться комментарием в случае внесения изменений в чужой или типовой блок/модуль/объект. Для полностью своих объектов комментировать каждую процедуру не требуется.
Рекомендуется для быстрой вставки комментариев использовать текстовые Шаблоны.
2.1. Новые переменные в разделе описания переменных
//+ ПРЕФИКС <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Описание задачи — опционально>
2.2. Перем НоваяПеременная1, НоваяПеременная2;
//- ПРЕФИКС <Фамилия И.О. разработчика>
2.3. Новые процедуры/функции в типовых модулях
Добавляются с префиксом «ПРЕФИКС_», кроме добавления стандартных обработчиков, описанных в п.2.8.
Новые процедуры/функции в модулях, разработанных самим разработчиком
Не нуждается в комментировании
2.4. Код внутри типовых модулей и в процедурах/функциях, разработанных другими разработчиками
//+ ПРЕФИКС <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Описание кода — опционально>
код
//- ПРЕФИКС <Фамилия И.О. разработчика>
Описание кода рекомендуется использовать в случаях сложных алгоритмов и при необходимости обратить внимание других разработчиков на некие особенности данного кода/блока/процедуры/запроса.
2.5. Код в процедурах/функциях, разработанных самим разработчиком
Не нуждается в комментировании
2.6. Удаление существующей процедуры/функции – типовой или разработанной другим разработчиком
Программный код тела, начала и окончания процедуры или функции должен быть закомментирован, а перед началом этой процедуры или функции и после его/ее окончания должен быть добавлен комментарий:
//+ ПРЕФИКС Комментирование <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Описание задачи — опционально>
//Процедура ИмяПроцедуры(ПараметрыПроцедуры)
// тело процедуры или функции
//КонецПроцедуры
//- ПРЕФИКС Комментирование <Фамилия И.О. разработчика>
2.7. Удаление существующей процедуры/функции, разработанной самим разработчиком
Не нуждается в комментировании
2.8. Если для решения задачи необходимо создать стандартный обработчик существующего в типовой конфигурации элемента формы или стандартный обработчик модуля объекта (ПередЗаписью, ПриЗаписи и т.п.), сначала стандартными средствами создается обработчик, а затем внутрь его помещается новый функционал по правилам п.1.4. То есть например, если в модуле объекта необходимо вставить код в процедуру ПриЗаписи(), которой нет, то результат будет следующий:
Процедура ПриЗаписи(Отказ)
//+ ПРЕФИКС <Фамилия И.О. разработчика> от <дд-мм-гггг>. <описание задачи — опционально>
код
//- ПРЕФИКС <Фамилия И.О. разработчика>
КонецПроцедуры
3. Изменение существующего типового функционала или функционала, написанного другим разработчиком.
//+ ПРЕФИКС Комментирование <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Причина изменения>
// старый код
//- ПРЕФИКС Комментирование <Фамилия И.О. разработчика>
//+ ПРЕФИКС <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Описание изменений — опционально>
новый код
//- ПРЕФИКС <Фамилия И.О. разработчика>
4. Любые добавления в нетиповой, исправленный, добавленный программный код, написанный другим разработчиком, комментируются в соответствие с п.2.4.
5. Создание новых объектов
При именование новых объектов конфигурации, новых реквизитов, форм, макетов, табличных частей должен использоваться префиксом «ПРЕФИКС_»
Все объекты конфигурации должны сортироваться в алфавитном порядке:
сначала типовые объекты, потом добавленные с префиксом «ПРЕФИКС_» и другими префиксами, если такие будут. При добавлении нового объекта рекомендуется сразу его передвигать по дереву в порядке сортировки.
5.1. При создании новых объектов конфигурации
— префикс «ПРЕФИКС_»
ПРЕФИКС_Справочник;
ПРЕФИКС_Документ.
5.2. При создании новых реквизитов, форм, макетов, табличных частей в типовые объекты:
-префикс «ПРЕФИКС_»
5.3. При создании новых реквизитов, форм, макетов, табличных частей в нетиповые объекты
— префикс не нужен
6. Использование перевода строки
В случае добавления кода в существующую строку типового, измененного, нового фрагмента программного кода допускается использовать перевод строки:
6.1. Вставка разделителей текста (пробел, перевод строки)
Процедура ВыполнитьОперацию(ТиповойПараметр1
//+ ПРЕФИКС <Фамилия И.О. разработчика> от <дд-мм-гггг>. <Описание задачи — опционально>
,Парам2
//- ПРЕФИКС <Фамилия И.О. разработчика>
,ТиповойПараметр3) Экспорт
Related Posts
Получение логина и пароля техподдержки 1С из базы
Класс для вывода отчета в Excel
Счет-фактура для УПП
Библиотека классов для создания внешней компоненты 1С на C#
Акт об оказании услуг (со скидками) — внешняя печатная форма для Управление торговлей 11.1.10.86
Прайс-лист с артикулом в отдельной колонке
(0) объектное извлечение данных хуже , чем по запросу? хотелось бы узнать
Не соглашусь. Очень удобно, когда новые объекты конфигурации добавляются в конец списка. В таком случае, во-первых ты имеешь представление о том, что делают другие участники команды, во-вторых часто возникает необходимость обратиться к объектам, добавленным пару месяцев назад, тобой или кем-то другим, при этом уже не помнишь или не знаешь точное название этих объектов. В этом случае просто открываешь список документов, бежишь глазами вверх и быстро находишь нужный объект
ОбщегоНазначения.ЗначениеРеквизитаОбъекта — не универсальный пример (может отсутствовать в конфигурации )
(0) 5 минут думал, в чем смысл листинга? красной рамкой и чертой — выделены фрагменты, которые не стоит использовать, зеленой рамкой — видимо, улучшенный вариант.
Оригинальная подача материала — удобно для восприятия, затратно по времени подготовки.
Как реализовали ?
(1) Здравствуйте !
При объектном чтении ( Например, ДокументСсылка.Номер )
из СУБД считываются не только реквизиты объекта, но (если есть)
и все табличные части и все реквизиты-хранилища, чтение происходит в транзакции.
Представляете, насколько это более затратно для СУБД, чем запрос
Выбрать ДокументПоступления.Номер
ИЗ Документы.ПоступлениеТоваровУслуг КАК ДокументПоступления
Где ДокументПоступления.Ссылка = &Ссылка
Поэтому в современных типовых программах разработчики не используют объектное чтение.
(2) оба варианта имеют право на жизнь.
для конечного продукта и конечного потребителя — лучше отсортировать, и тогда — когда внедренец будет добавлять свои объекты — он будет различать , где типовые (по поставке продукта), а где его.
в вашем случае — при разработке продукта и тем более в команде удобно видеть новые создаваемые объекты, поэтому сортировать не целесообразно.
Сортировка должна происходить между процессом разработки и продажей продукта — получается промежуточным этапом.
(2) Здравствуйте !
мне тоже было непривычно, потом понравилось.
Специально проверил — в типовой все сортировано.
(4) Сделал три картинки и объединил, использовал gif — редакторhttps://ezgif.com/maker
«фигня ваша заливная рыба» — это я о клиповом мышление.
клипофилы губят в себе образное мышление и без устройства отображения они никто.
(3) Здравствуйте !
Если отсутствует, то имеет смысл добавить. Очень полезная функция.
(5) хорошо, принял.
но вы ориентируетесь на то, что якобы знаете как работает платформа.
а вы уверены, что разработчики платформы заложили именно такой «затратный по производительности» механизм объектного извлечения данных?
то есть по сути, мне нужен ИНН контрагента, я прописал Контрагент.ИНН. А они заложили в платформе, что тащится весь справочник Контрагентов со всеми табличными частями? Может быть, стоит им написать, чтобы они улучшили свой алгоритм и не извлекали лишнего?
(9) Здравствуйте !
Думаете, это мышление мы как-то можем улучшить ?
(3)
Во всех типовых конфигурациях есть БСП, самописки пишутся на базе БСП, скопировать 4 функции из БСП — также бесценно, как и «таблица значений в массив»
(11) Это известная проблема, по ней много публикаций.
Я проверял в профайлере, всегда работает одинаково.
Разработчики платформы хотели бы что-то изменить,
но их связывает обратная совместимость и прочие обязательства.
(7)
При выпуске коробки конечно же необходимо сортировать.
Но в публикации вроде это нигде не уточняется
Добавил вознаграждение за конструктивные предложения и дополнения.
(11)
при объектном чтении, все таки, возможно, проблема не в том, что тащатся все реквизиты с табличными частями, а скорее в случаях, когда пишут такой код:
В этом случае, вроде как выполняется три запроса, а при использовании функции ОбщегоНазначения.ЗначениеРеквизита() — это можно сделать за одно обращение к БД. Хотя тут, возможно, используется кэш, но это неточно.
(11)
(17) Когда объектное чтение происходит первый раз, то объект кешируется
и в следующих случаях запросов к СУБД нет. Но это все равно плохо.
Посмотрите ссылку комментария (18).
(17)
Ну вот в таком случае я бы сказал, что 99% вероятности того, что будет использоваться кэш. Ибо за три строчки кода вряд ли объект из кэша выветрится..
// Занудство ON
(5) Не лучший пример (получение поля «номер»). Основные поля прикладных объектов кэшируются без чтения всего объекта. При их получении через точку весь объект не будет считан. А вот ДокументСсылка.Организация, считает весь объект.
// Занудство OFF
(2)
Не соглашусь с «не соглашусь».
При обновлении этот принцип «новые объекты конфигурации добавляются в конец» — херится напрочь. В итоге — в конце списка тупо каша из добавленных кастомных объектов и новых объектов типовых..
Если требуется систематизировать работу с кастомными объектами — лучше их выделять в отдельную подсистему/подсистемы.
(21) Здравствуйте !
Для меня это не занудство. я сам такой.
Мне это интересно для подготовки к экзамену.
Можете привести ссылку на первоисточник ?
(21) вот же ссылка на стандарт разработки в посте (18), а далее по ссылке пример — тащим Наименование страны через запрос, а не через точку.
Поэтому вопрос:откуда вы взяли, что
(21)
?
(0) Коллеги, я вот учился в 2008 году по книге Радченко, где было написано, что извлекать данные можно объектно и по запросу. Не было оговорок про производительность того или иного способа. Наоборот, местами было удобнее использовать объектное обращение к переменным: ПолучитьПоследнее() по регистру сведений — например, цену или курс доллара.
А сейчас, цену не стоит так извлекать? Что потащится из базы при использовании такой конструкции? вроде как вся запись по отбору регистра сведений….
(23) Хм. В Профразработке для версии 8.0, вроде было так, а в книге для 8.3 (том 1, стр 72) указано, что неполное чтение используется только для получения представления типа строка(ДокументСсылка). Так что похоже я неверно написал.
(25) Да, объектные чтения регистров тоже имеют аналогичные недостатки.
И хотя для регистров нет однозначного ответа, но на мой взгляд лучше запрос.
(26) Объектное чтение проходит без транзакции, если у объекта нет табличных частей.
(5)при этом обращение напрямую к регистру например сводные остатки идет быстрей чем через запрос.
Везде пишут не используйте это не используйте при этом типовые конфы такое вытворяют… что думаешь там рельно ии уже сидит и по тз код строчит
Спасибо, интересно.
(25) В объектном чтении нет ничего плохого если хорошо понимаешь как оно работает.
Например если на регистр наложен РЛС, объектное чтение набора с запрещенными записями выдает исключение.
(30) Здравствуйте !
Лично для меня открытием стала книга С. Макконела «Совершенный код».
Некоторые главы как будто специально для 1С написаны.
2.2. Перем НоваяПеременная1, НоваяПеременная2;
//- ПРЕФИКС <Фамилия И.О. разработчика>
Модный нынче Git еще не освоили?
Этот и последующие образцы для комментирования — разве не дурной тон по тому же Макконнеллу? Представьте один типовой модуль, в который раз в месяц один из разработчиков вносит изменения. Этот модуль уже через год-два превратится в зеленую лужайку из-за комментариев, где кое-где встречаются конструкции языка. Такой «зеленый» модуль усложняет чтение самого кода.
И еще зачем использовать «ПРЕФИКС_» в добавлении ко всем объектам, реквизитам, функциям и так далее? Вот никогда не понимал, почему так делают. Мое предположение, что это было крайне важно в 7.7 (я с ней не работал), и программисты старой закалки перетащили это в 8.х, где это не приносит существенной пользы.
(33)
Вот если модуль типовой то как раз пусть вносит комментарии, кто, когда и что изменял или дополнял. Если же модуль его собственный то тут уже по ситуации.
(33) Здравствуйте !
есть мнение, что такие комментарии — нелепые и что EDT и GIT вскоре решат эту проблему.
Но пока сам не пробовал. Мы используем именно такие комментарии.
Это помогает при обновлении и поддержке. Возможно, это не эталон.
(34)
ФИО разработчика и когда внесено изменение — это задача системы контроля версий.
(35) уже решено и без GIT’a.
Используется обычное хранилище, разработчики также работают. Настроен скрипт на OneScript, который при помещении коммита в хранилище, добавляет информацию в git.
На инфостарте уже два года про это статьи пишут.
(37) А сами Вы GIT используете ?
(36)
Это при условии что система контроля используется.
ЭЭЭЭ… Не понял. А где обещанные клипы ?
(40) Здравствуйте !
Гифки подходят ?
Что за «Piton»?)
(42) Здравствуйте !
Взял для примера посторонний язык программирования ((.
Казалось, популярный.
(43)Правильно писать Python
(44) Спасибо, исправил. Перечислил СМ в знак благодарности.
(38) да, на проектах, где больше одного человека занимаются разработкой. Если я один или если прихожу на проект, где всё по-своему устроено — то нет.
(46) Интересно. Может, и мы доживем.
Добрый день
Спасибо за статью, сам все хочу приобрести эту книгу, но никак руки не доходят. Вы говорите, что она хорошо подходит и для 1С?
Вопросы, замечания по тексту:
1. ЗначениеРеквизитаОбъекта — а разве можно передавать структуру, чтобы получить реквизит реквизита? У вас какая-то доработанная версия?
2. Честно говоря, мне не нравится как 1С выравнивает многострочные логич выражения. Я бы их ставил на уровне первого Если, а не вложенного кода. Я один такой?
3. «аргументы функции (процедуры) при возможности сохранять в структуре значений, которая будет единственным аргументом» — вот что-то никак не могу это принять. Да, для кастомизации это круто, можно спокойно добавлять новый параметр, не переписывая везде интерфейс. Но вот для понимания и читабельности… Что, кому-то это удобнее? Тут становится понятно только по описывающему комментарию перед функцией. Но ведь рядом же написана мысль, что хороший код в комментах не нуждается.
4. «Модули форм оформляются через области, используя стандартные и, при необходимости, свои» — список, что дальше, это официальный, из ИТС? Не встречал его раньше.
P.S. Сама подача материала не очень понравилась. Я не приветствую клиповость, особенно для статей на такую серьезную тему. Лучше текст почитать.
С другой стороны, может вам здесь как раз не хватило этой клиповости. Вы в начале написали, я ждал какой-то яркой картинки, а в итоге не сразу заметил, что картинки вообще меняются. Если уж идти в этом направлении, то должны быть стрелки, другие яркие элементы для привлечения внимания, какая-то динамика.
(48) Здравствуйте !
1. Да, попробуйте сами. У нас версия БСП не новая.
2. Возможно, 1С выравнивает многострочные логич выражения не лучшим способом.
я исходил из девиза «Безобразно, но однообразно»
3. Использовать структуру как аргумент — это тренд производителя. В этом что-то есть.
4. Список областей не входит в стандартные требования. Но применяется часто.
5. По теме много серьезных статей. Хотелось как-то выделиться. Стрелочки наверное добавлю.
(49) 1:
Попробовал пример, как у вас, в УТ 11.4, выдало ошибку:
Зато работает такой способ: ОбщегоНазначения.ЗначениеРеквизитаОбъекта(Ссылка, «Контрагент.ИНН»)
(49)
2. Да, в общем, девиз правильный, просто решил поделиться, мнение узнать.
3. В смысле, тренд 1С? А где такое можно посмотреть? Как-то везде пока вижу кучу аргументов.
(50) я давно так структуру использую. Посмотрите, может Вы или я в примере аргументы поменяли местами ?
(51) Например, ДополнительныеСвойства объекта.
Недавно обновлял типовую конфигурацию,
видел несколько функций где 1С заменили несколько аргументов на структуру.
Найти ссылку на ИТС про аргументы ?
(52) Да нет, ну я смотрю код функции, она не может структуру съест. А что у вас за БСП? Из какой конфигурации?
(53) Да, если не сложно. Было бы интересно.
Даже не касаясь темы клипового мышления, все это давно описано в «Системе стандартов и методик разработки конфигураций» на ИТС. Статья рассчитывалась на разработчиков 1С, не знакомых со стандартами разработки в своей области?
(56) Здравствуйте !
В статье нет копипаста с ИТС.
Некоторые разработчики 1С не читали «Совершенный код».
На это и рассчитываю.
(54) у меня УТ 11.4.2.144 Ниже описание функции ЗначенияРеквизитовОбъекта. Седьмая сверху строка — тип Структура. Но возможно, я неправильно написал на картинке синтаксис.
// Параметры:
// Ссылка — ЛюбаяСсылка — объект, значения реквизитов которого необходимо получить.
// — Строка — полное имя предопределенного элемента, значения реквизитов которого необходимо получить.
// Реквизиты — Строка — имена реквизитов, перечисленные через запятую, в формате
// требований к свойствам структуры.
// Например, «Код, Наименование, Родитель».
// — Структура, ФиксированнаяСтруктура — в качестве ключа передается
// псевдоним поля для возвращаемой структуры с результатом, а в качестве
// значения (опционально) фактическое имя поля в таблице.
// Если ключ задан, а значение не определено, то имя поля берется из ключа.
// — Массив, ФиксированныйМассив — имена реквизитов в формате требований
// к свойствам структуры.
// ВыбратьРазрешенные — Булево — если Истина, то запрос к объекту выполняется с учетом прав пользователя, и в случае,
// — если есть ограничение на уровне записей, то все реквизиты вернутся
// со значением Неопределено;
// — если нет прав для работы с таблицей, то возникнет исключение.
// — если Ложь, то возникнет исключение при отсутствии прав на таблицу
// или любой из реквизитов.
//
// Возвращаемое значение:
// Структура — содержит имена (ключи) и значения затребованных реквизитов.
// — если в параметр Реквизиты передана пустая строка, то возвращается пустая структура.
// — если в параметр Ссылка передана пустая ссылка, то возвращается структура,
// соответствующая именам реквизитов со значениями Неопределено.
// — если в параметр Ссылка передана ссылка несуществующего объекта (битая ссылка),
// то все реквизиты вернутся со значением Неопределено.
//
Функция ЗначенияРеквизитовОбъекта(Ссылка, Знач Реквизиты, ВыбратьРазрешенные = Ложь) Экспорт
Раз Вы не против занудства, позвольте и мне вставить свое. 🙂
В первом пункте некорректно рассчитывается сумма товаров документа.
Во-первых, Вы используете для обхода выборки цикл, тогда как в результате запроса будет всегда ровно одна строка. На мой взгляд, с которым Вы вполне законно можете не согласиться, для получения данных выборки, где может быть не более одной строки корректнее использовать конструкцию «Если», а не «Цикл». Причина та же, что и для правил именования переменных: так мы подсказываем читающему код разработчику, что в результате не может быть более одной строки. Но это дело вкуса.
Во-вторых, возможны ситуации, когда результатом вычисления суммы товаров документа будет NULL. Это случай с пустой табличной частью «Товары». Мне кажется это также неожиданным для дальнейшего использования результатом, и предпочтительнее здесь получить именно 0. На это намекает инициализация переменой суммы и наличие цикла обхода выборки вместо безусловного «Выборка.Следующий()». Но конечно же, что возвращать — NULL или 0, зависит от решаемой задачи.
(58) Так мы с вами про разные функции говорим? У вас в примере ЗначениеРеквизитаОбъекта
(60)
Где можно «международный стандарт» почитать? На сколько знаю от ВН отказались даже в МС где изначально её и придумали применять.
(60) Не надо тащить стандарты 30-летней давности для строго типизированных языков туда, где они не сдались (я про венгерскую нотацию). В коде 1С такие вещи смотрятся как пульт ДУ в полиэтилене (неуместно).
(63) «Это может пригодиться:
https://ru.wikipedia.org/wiki/%D0%92%D0%B5%D0%BD%D0%B3%D0%B5%D1%80%D1%81%D0%BA%D0 %B0%D1%8F_%D0%BD%D0%BE%D1%82%D0%B0%D1%86%D0%B8%D1%8F
…В языках с динамической типизацией»
в википедии так и написано что это хорошо для динамический типизации типа как в 1С
(64) я больше доверяю стандарту 1С, в котором про венгерскую нотацию ничего не сказано:https://its.1c.ru/db/v8std
(64)https://docs.microsoft.com/en-us/dotnet/standard/design-guidelines/general-naming-conventions
(60) есть стандарты разработки 1Сhttps://its.1c.ru/db/v8std , почитайте, прежде чем сюда писать «Так нельзя». Я предпочту видеть перед глазами единообразный код соответствующий стандартам разработки, а не программиста, который следует «Венгерской нотации».
(66) по ссылке написано:
«…General Naming Conventions Microsoft .NET
— DO NOT use Hungarian notation.»
В хороших языках программирования со строгой типизацией венгерская нотация не нужна конечно, там тип переменной итак строго задан, но это не про 1С
(67) посылать на три буквы (www) все умеют,
а сказать что-нибудь внятное уже сложнее
(68)пишу на одном скриптовом языке с динамической типизацией, в соглашении к этому языку не встречал рекомендаций использовать ВН. Хотя вот аннотацию типов вводят в стандарты.
(59) да, там может быть Null. Исправлю, спасибо.
(70) в википедии так и написано
«…ни само наличие префиксов, ни их написание не являются требованием языков программирования»
(60) Здравствуйте !
в статье речь идет о стандартах 1С, поэтому лучше ссылаться на сайт ИТС, чем на Вики.
Откуда Вы набрали таких категоричных утверждений ?
Можете привести источник ?
(73) с автором спорить бесполезно уж, «он» никогда не признается в неправильности своей статьи.
Лучше подождём что люди скажут 🙂
2) не надо думать что «сайт ИТС» более авторитетный чем википедия 🙂
Вот мне интересно, насколько ожидаема ситуация, что люди, для которых «время-деньги» вместо 1 строки с разыменованием объекта будут писать простынку запроса с обходом результата?
(74) Сайт производителя программного продукта 1С ИТС.
В комментариях я несколько раз признал свою неправоту
и перечислил СМ в знак благодарности.
(75) Здравствуйте !
В типовой УТ 11 нет объектных чтений.
А нам нужно к этому стремиться.
(55) (53) (51)
Про аргументы в заголовке функции:
Правильно сгруппировать параметры, описывающие значения реквизитов номенклатуры, в структуру ЗначенияРеквизитов:
(74)
1) Давно Вики стала авторитетным источником учитывая что вносить правки в неё может любой желающий, даже не имеющий опыта работы программистом?
2) В вопросе написания когда под 1С сайт ИТС куда авторитетнее чем Вики.
(79) Почитал. Согласен, если параметров много, то следует сгруппировать их по структурам. Но про то, что нужно все функции делать с одним параметром, даже если их подразумевается три, не написано.
(77) в языке java тоже раньше делали такой «ускоряющий» код,
но теперь придумали новый псевдоязык Query DSL
смысл которого только в том что при неправильном написании имени поля(колонки БД) приведёт к ошибке в DesignTime(IDE,конфигуратор) а не в RunTime(у пользователей)
Просто 1С отстаёт лет на 5-10 от нормальных языков программирования.
Надёжность программы намного важнее чем скорость !
(81) да, как-то так ))
(49) структура как аргумент — не просто тренд, а стандарт, описанный на ИТС. С телефона не найду ссылку, но там говорится про методы, имеющие большое количество параметров (ориентироваться следует на 5 и более)
Про список областей — то же самое: есть стандарт на ИТС.
ЗначениеРеквизитаОбъекта — исчерпывающую информацию можно получить прямо из описания метода (в том числе примеры вызова). Сигнатура и способы вызова не менялись очень давно, то есть, описанный пример актуален и для древних конфигураций
(69) Поддержу по примеру 4,
Текстовый редактор системы 1С:Предприятие предоставляет функции автоматического форматирования управляющих конструкций встроенного языка.
Помимо автоматического форматирования текста модуля в процессе ввода, можно также отформатировать уже введенный текст. Для этого необходимо выделить блок текста, который требуется отформатировать, и выбрать «Текст — Блок — Форматировать». При этом текстовый редактор проанализирует текст модуля и произведет его форматирование, при котором содержимое каждой синтаксической конструкции будет сдвинуто вправо на величину табуляции независимо от первоначального расположения строк (лидирующих пробелов).
(с) сп
Встроенный инструмент форматирования предназначен для оформления управляющих конструкций встроенного языка и не умеет ни в один из пунктовhttps://its.1c.ru/db/v8std#content:444:hdoc:_top:перенос%20выражений .
Поэтому аппелирование к нему в данном случае считаю некорректным, а отступы конструктора запросов более каноничными.
(25) Добрый день, различие будет, если прочитать набор записей внутри внешней транзакции (при проведении) и потом записать. Разделяемая управляемая блокировка (накладывается при Набор.Прочитать()) превратится в исключительную (Набор.Записать()), а это потенциальный deadlock.
А с объектным чтением документа с табличными частями почему то не воспроизвелось, нет и все разделяемой управляемой блокировки. ))
(60)Мне нравится вот так писать условия (когда их больше 2,3-х)
Показать
В общем люблю когда условия выровнены
Аналогично хорошо так же декларировать аргументы функций и вызовы самих функций (когда их больше 3,4, хотя большое число аргументов у функций — тоже считается не очень хорошим тоном — но если они в основном не обязательны и могут быть заданы поименовано при вызове функции — то это даже очень удобно)
Показать
Жаль 1С не поддерживает именованные аргументы — как многие из современных языков программирования — типа вот так:
Ну а про отсутствие в 1С кортежей — я вообще молчу 🙁
Хотя динамические структуры — вещь очень полезная — предпочитаю их для передачи параметров!
(49) «4. Список областей не входит в стандартные требования. Но применяется часто. »
Уже входит.
(45)Исправили не совсем точно. У Вас «Pyton». И в Python’e всё таки 4 пробела, а не табуляция.
(125) Спасибо.
(113)
1) слово «Тогда» надо с отступом
2) аргументы с новой строки хорошо когда их больше чем 3-4 шт.
3) «именованные аргументы» — фигня какая-то
(83)Да, в 1С очень не хватает псевдодекларативной техники организации выборок из БД (и не только из БД) по аналогии описанной Вами, или LINQ из C#
А вообще — будущее за декларативными языками описания бизнес логики — где написанные команды будут восприниматься как требования и намерения к достижению результата, а интерпретатор ещё на стадии конфигурирования будет их перекладывать на оптимальные внутренние инструкции к runtime-процессору (каким бы он ни был — оптимально сейчас — это LLVM-машина или Java runtime-машина, но можно и сразу в инструкции ЦПУ компилировать — хотя это плохая идея, уж лучше сначала в LLVM-код а уже на стадии выполнения делать JIT-компиляцию), с оптимизацией и распараллеливанием выполнения, при необходимости.
(83) Поддерживаю!
Код мы читаем раз в сто больше, чем пишем. Порой приходится для одной строки прочитать целый фолиант. А это все ВРЕМЯ, а значит ДЕНЬГИ. А зачем все это надо можно почитать вбив в Гугле «чистый код». Наверное не зря признанные метры программирования столько пишут об этом. Огорчает, что низкий порог вхождения в профессию программист 1С тянет за собой тонны кода, с которым потом бизнесу приходится жить и оплачивать потраченное программистами время.
(73) В своей книге автор писал, что он не заставляет писать так, как он говорит, он лишь приводит свои примеры и примеры других известных программистов, почему так ему кажется удобнее. Я книгу давно читал, но не могу вспомнить, почему не стоит писать тип переменной перед ее параметром? Конкретно меня интересуют такие переменные типа «СтруктураПараметровПолученияПортфелейКонтрагентов» или «ТаблицаЗначенийПредварительнаяНовогоПортфеля». Почему тут плохо использовать Структура и ТаблицаЗначений?
(136) Здравствуйте !
Использовать Структура и ТаблицаЗначений в наименовании не плохо и не хорошо.
Но в свежем коде производителя это как правило не используется.
(136)
Указание типа переменной в языке с динамической типизацией может ввести в заблуждение относительно её типа.
Ничего плохого нет в переменной тзПредварительная, плохо когда начинают весь код писать в таком стиле, придумывают целую систему типов, начинают в название переменной добавлять префиксы означающие простые типы и тд.
(1)
(11)
Добавили бы в конфигуратор для всех реквизитов признак «Вызов через точку» — чтобы не тащить все остальные поля при такой конструкции «Контрагент.ИНН».