<< Click to Display Table of Contents >> Разработка > Программный код > Функции > Создание функций вычисляемых выражений Рекомендации по именованию функций вычисляемых выражений |
Из наименования и подсказок к функции аналитику должно быть понятно, как она работает и какие у нее параметры. Кроме того, для удобства использования создаваемые функции должны называться единообразно. Чтобы достичь этого, соблюдайте рекомендации.
Общие советы
При создании функций вычисляемых выражений рекомендуется:
•наименование функции писать с большой буквы, на естественном языке с пробелами между словами;
•использовать короткое наименование функции, чтобы итоговое выражение тоже получилось коротким;
•в наименовании отражать ключевую суть функции, опустить детали;
•в наименовании использовать общепринятые сокращения, например, «КЭДО», «НДС», «ч.», «руб.», а также сокращения, принятые внутри компании.
Именование в зависимости от типа возвращаемого значения
Если функция возвращает ссылку на объект, то в качестве наименования рекомендуется использовать существительное в единственном числе в именительном падеже. Примеры: •Задача → Контролер → Непосредственный руководитель •Задача → Сотрудник → Ресурс-менеджер •Задача → Адресат → Помощник |
Если функция возвращает коллекцию элементов, то в качестве наименования рекомендуется использовать существительное во множественном числе в именительном падеже. При этом в наименовании рекомендуется опустить слово «коллекция», чтобы не увеличивать длину вычисляемого выражения. Примеры: •Задача → Все участники •Задача → Участники повторного ознакомления •Задача → Приложения |
Функция может возвращать коллекцию, но при этом быть доступна только в определенном типе задач и/или уточнять контекст для коллекции только определенного типа. В этом случае рекомендуется, чтобы наименование содержало существительное во множественном числе и суть уточнения. Примеры: •Задача → Участники ознакомления → Участники с КЭДО •Задача → Участники ознакомления → Участники без КЭДО •Задача → Участники повторного ознакомления |
В вычисляемых выражениях могут использоваться функции с преобразованием данных. Такие функции не только возвращают существующие в системе данные, но и изменяют их. В том числе могут быть получены новые данные другого типа. Рекомендуется в наименование функции включить краткую суть преобразования. Примеры: •Задача → Согласующие → Список ФИО в текст •Задача → Кандидат → Фамилия и инициалы •Задача → Тема в переписке → Обрезать до N символов |
Если функция возвращает целое значение, то рекомендуется в наименование включить существительное и единицу измерения. Примеры: •Задача → Вложения → Количество элементов •Задача → Инициатор → Стаж, лет •Задача → Относительный срок, ч. |
Если функция возвращает логическое значение, то наименование рекомендуется указывать в виде вопроса. Примеры: •Задача → Документ на ознакомление → Все → Первый элемент → Подписан? •Задача → Сотрудник → Подразделение → Производственное? •Задача → Задачи созданы для всех адресатов? •Задача → Это подзадача? |
Подсказка для функций
Подсказка включает в себя краткое описание функции и параметров, если они используются. Описание функции рекомендуется начинать с глагола в неопределенной форме.
Полное описание функции задается с помощью атрибута ExpressionElement в формате:
[ExpressionElement("<Имя функции>", "<Описание функции>", "", "<Описание параметра 2>", "<Описание параметра 3>", "<Описание параметра N>")]
Пример атрибута для функции с входными параметрами:
[ExpressionElement("Обрезать до N символов", "Обрезать строку до N символов", "", "Количество символов")]
Примеры атрибутов для функций без входных параметров:
[ExpressionElement("В верхнем регистре", "Перевести строку в верхний регистр")]
[ExpressionElement("Участники ознакомления", "Получить список участников ознакомления")]
ПРИМЕЧАНИЕ. На практике вместо явного задания текста рекомендуется использовать строки локализации.
© Компания Directum, 2024 |