Что может быть самым сложным для программиста? Правильно, придумать имя для переменной! Что бы конфигурация была удобочитаемой, приведу некоторые стандарты, которые описывают правила именования объектов конфигурации, переменных, процедур, функций, элементов управления и т. д.
Правила составления имен переменных
Имена переменных или параметров следует образовывать от терминов предметной области. При составлении имени переменной нужно использовать только термины, используемые в документации к 1С:Предприятию или в методических материалах фирмы 1С. Из имени переменной должно быть понятно ее назначение и какую роль она выполняет.
Имена следует составлять путем склеивания слов, удаляя пробелы между ними. Каждое отдельное слово в склеенном имени пишется с прописной буквы. Предлоги и местоимения из одной буквы также пишутся прописными буквами.
Пример правильного имени:
- работа с каталогом – РаботаСКаталогом;
- количество пачек в коробке – КоличествоПачекВКоробке.
Имена переменных не следует начинать с подчеркивания. Имена переменных ни в коем случае не должны состоять из одного символа, но использование коротких имен переменных допускается только для счетчиков циклов, например: счетчик — Сч.
Как установить программу без прав администратора в Windows 10
При написании процедур периодически используются переменные, которые содержат в себе некий флаг. Такие переменные следует называть так, как называется истинное значение этого флага. Например, если нужна переменная, которая отвечает за признак наличия ошибок в процедуре, то она должна называться ЕстьОшибки. Или если есть признак того, что товар относится к возвратной таре, то он должен называться ЭтоТара.
Правила составления имен процедур/функций
Имена процедур в общем случае следует образовывать от глаголов неопределенного вида, например: ПроверитьДублиСтрок(), ЗагрузитьКонтрагента(). Вот так будет выглядеть неправильное именование: ПроверкаДублейСтрок(), ЗагрузкаКонтрагента(). Имена процедур (функции) должны давать представление о характере выполняемых действий процедурой (функцией).
Функции, которые предназначены для проверки чего-либо и возвращают в качестве результата проверки булево значение, следует именовать так, как называется результат проверки, имеющий значение Истина. Например, если функция должна проверить наличие дублей строк в табличной части документа, то она должна именоваться ЕстьДублиСтрок(). Или если функция должна проверить принадлежность документа к накладным, то она должна именоваться ЭтоНакладная(). Однако если функция (процедура) ЕстьДублиСтрок() проверяет наличие дублей строк и выполняет объединение дублирующих строк, при этом не возвращая значения, ее следует именовать СвернутьДублиСтрок(), так как имя должно представлять характер действий.
Имена обработчиков событий формирутся системой автоматически:
+
Имена по-умолчанию формируются при нажатии символа лупы около события в окне свойств реквизита диалога. По таким же правилам следует образовывать имена обработчиков самостоятельно.
Как запустить программу без прав администратора
 |
| 1. Пример правильного кода |
Правила составления имен элементов управления
- если надпись относится к элементу управления, имя составляется как
Надпись + ИмяЭлементаУправления; - в остальных случаях имя составляется как
Надпись + ИмяНадписи.
Общие требования к имени объекта конфигурации, синониму и комментарию
Имя объекта надо стремиться строить на основе синонима объекта, так, как это делает система автоматически: пробелы и прочие недопустимые символы удаляются, первые буквы слов делаются заглавными. Сокращения слов (относительно синонима) допускаются только в крайних случаях, при этом необходимо, чтобы по сокращению можно было восстановить слово обратно. В случае длинных синонимов последние слова могут быть опущены, если это не искажает смысла.
Для реквизитов объектов допускается переставлять слова из синонима местами, например: для синонима Полное наименование, имя может быть НаименованиеПолное. Для ведущих объектов подобное не допускается.
Синоним объекта должен быть определен так, чтобы осмысленно описывать объект. Сокращения допускаются только общепринятые, например, ОКАТО, ИНН. Следует избегать излишне длинных синонимов, но и укорачивать их с потерей смысла тоже плохо. Синоним начинается с большой буквы, точки ставятся только после сокращений. Для ведущих объектов метаданных необходимо стремиться к тому, чтобы название объекта в меню, подпись в диалоговых формах совпадали с синонимом или как минимум начинались с него.
Для реквизитов объектов подписи в диалогах могут отличаться. Синоним надо выбирать так, чтобы он осмысленно описывал реквизит в возможных универсальных формах.
Для форм синоним должен начинаться со слов, генерируемых конструктором при создании формы (Форма списка…, Форма элемента… и т. д.). Далее, в случае наличия нескольких форм одного назначения, обязательно должно следовать уточнение, например Форма элемента полная, Форма элемента упрощенная. Для макетов унифицированных форм синоним должен состоять из названия формы, например: ТОРГ-12.
Комментарий задается только в тех случаях, когда необходимы какие-либо пояснения. Комментарий начинается с большой буквы, точки ставятся только после сокращений. Если в синониме использовано сокращение, в комментарии необходимо его расшифровать, например: Идентификационный номер налогоплательщика.
Для реквизитов объектов в комментариях в необходимых случаях должно содержаться уточнение, например: Сумма со всеми налогами.
Источник: 1centerprise8.blogspot.com
Стиль программирования, соглашения об именовании
Хорошее имя имеет огромное значение для читабельности программы. Такие имена, как proc1 , proc2 , и proc3 ничего не означают, но даже кажущиеся достойными имена могут быть сомнительными. Например, чтобы назвать функцию, которая принимает два диапазона и вычисляет сумму первых, которая лежит в пределах второй, могут показаться уместными имена, как computeRangeWithinRange . К сожалению, это имя не дает никакой информации о порядке аргументов функции. Иногда это не будет проблемой, потому что интеллектуальная интегрированная среда разработки должна помочь вам определить имена аргументов функции, но это может ввести в заблуждение, когда код будет напечатан, или когда вы пытаетесь быстро прочитать код. Лучше дать имя computeRangeWithinFirstRange , которое по крайней мере, покажет порядок аргументов функции.
Общие соглашения об именовании
Как правило, лучше выбрать набор соглашений об именовании для использования во всем коде. Соглашения об именовании обычно регулируют такие вещи, как использование переменных, классов и функций, будете ли вы включать префикс для указателей, статические или глобальные данные, и как вы указываете то, что является закрытым полем класса.
Есть много общего в именовании классов, функций и объектов. Обычно они разбиты на несколько основных категорий: си-стиль именования, camelCase и CamelCase . Си-стиль именования отделяет слова в имени, используя подчеркивание: this_is_an_identifer . Есть две формы CamelCase : первая начинается со строчной буквы, затем первая буква каждого последующего слова прописная, и вторая, где первая буква каждого слова прописная.
Одним из популярных соглашений является то, что прописные буквы CamelCase используются для имен структур и классов, в то время как camelCase используется для имен функций и переменных (хотя иногда переменные записываются в си-стиле, чтобы сделать визуальное разделение между функциями и переменными более ясным).
Может быть полезно использовать префиксы для определенных типов данных, чтобы напомнить вам, какие они есть: например, если у вас есть указатель pointer , стоящее перед ним p_ скажет вам, что это указатель. Если вы видите соответствие между переменными, одна из которых начинается с p_ , а другая нет, то вы сразу понимаете, что это подозрительно. Также может быть полезно использовать префикс для глобальных или статических переменных, поскольку каждая из них ведет себя не так, как обычные локальные переменные. В случае глобальных переменных, особенно полезно использовать префикс для предотвращения конфликтов имен с локальными переменными (что может привести к путанице).
Наконец, частое соглашение — ставить подчеркивание перед закрытыми полями и методами класса, например: _private_data . Это помогает легче находить объявления методов в теле класса, а также покажет, что вы должны и не должны делать с переменной. Например, общее правило избегать возвращения неконстантных ссылок на поля класса от функций, которые являются более открытыми, чем поле. Например, если _age является закрытым полем, то открытая функция getAge , вероятно, не должна возвращать неконстантную ссылку, поскольку это дает полный доступ к закрытому полю!
Венгерская нотация
Венгерская нотация связана с префиксом переменных с информацией об их типе — например, является ли переменная integer или double. Обычно этого не стоит делать, потому что ваш IDE подскажет вам тип переменной, а такой стиль может привести к странным и сложным именам. Оригинальная идея венгерской нотации, была более общей и полезной: создание абстрактных имен с помощью префиксов, которые описывают использование переменной, а не ее представление. Есть префиксы, которые задают тип переменной, например: s — string , b — bool , g_ — global и т. д. А есть префиксы которые задают смысл этой переменной, например: i — index , n — number и т. д. Это может быть полезно для разделения указателей и целых чисел, а также может быть мощным средством разделения понятий, которые часто используются вместе, но которые не следует путать.
Сокращения
Сокращения опасны — гласные буквы полезны и могут ускорить считывание кода. Использование сокращений может быть полезно, когда имя очень длинное, потому что слишком длинные имена столь же трудно читать, как и слишком короткие. Будьте последовательны, если это возможно, и ограничивайте себя в использовании сокращений.
Общие сокращения включают « itr » для « iterator » или « ptr » для pointer . Даже такие имена, как i , j , k прекрасно подходят для счетчика цикла переменных (в первую очередь потому, что они так часто употребляются). Неудачные сокращения похожи на cmptRngFrmRng , которые, экономя лишь несколько букв, затрудняют чтение. Если вы не хотите набирать длинные имена, поищите авто-завершение в вашем текстовом редакторе. Вам не придется часто вводить полный идентификатор. (На самом деле, вы редко об этом задумываетесь: опечатки невероятно трудно обнаружить.)
Источник: cppstudio.com
Создание макроса
Чтобы написать макрос (в дальнейшем макросы будем называть словом «программа»), надо запустить на выполнение Excel и нажать кнопки ALT+F8 (либо выбрать в ленте инструментов Excel закладку «Вид», затем кликнуть мышью по инструменту «Макросы»). Появится диалоговое окно «Макрос» с курсором, мигающим в поле ввода «Имя макроса:». Здесь требуется ввести произвольное имя создаваемой программы.
Требования к имени программы:
· В имени допускается использовать латинские, русские буквы, цифры, знак подчёркивания «_»;
· Первый символ имени должен быть буквой;
· Максимальная длина имени 255 символов;
· Нельзя использовать пробел (если требуется, чтобы имя состояло из нескольких слов, то вместо пробела надо использовать символ подчёркивания либо записывать слова слитно, при этом начиная каждое слово с заглавной буквы).
Примеры названия программы:
Как только пользователь введёт имя программы, в диалоговом окне «Макросы» станет доступна кнопка «Создать».
При нажатии на неё будет запущен на выполнение VBA (в дальнейшем будем для краткости называть программу Visual Basic for Applications просто Visual Basic). В одном из окон Visual Basic мы увидим начальный текст создаваемой программы:
Понравилась статья? Добавь ее в закладку (CTRL+D) и не забудь поделиться с друзьями:
Источник: studopedia.ru