--- title: "Best Practices for Naming Elements in Tulip" slug: "best-practices-for-naming-elements-in-tulip-1" updated: 2023-10-31T15:34:08Z published: 2023-10-31T15:34:08Z canonical: "support.tulip.co/best-practices-for-naming-elements-in-tulip-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://support.tulip.co/llms.txt > Use this file to discover all available pages before exploring further. # Лучшие практики присвоения имен элементам в Tulip ## Назначение *Обзор лучших практик по именованию пользовательских элементов в Tulip в качестве отправной точки для ваших собственных приложений и соглашений по именованию.* Все пользовательские именованные элементы, например, переменные, шаги, записи и т.д., в Tulip должны быть названы таким образом, чтобы они были читаемыми, однозначными и понятными для облегчения использования приложений в течение их жизненного цикла. Рекомендуется принять следующие общие соглашения об именовании для всех элементов: - Описательное имя - Слова пишутся полностью, без сокращений - Первая буква каждого слова в верхнем регистре, последующие буквы в нижнем регистре - Отдельные слова разделяются пробелом | | | | | | --- | --- | --- | | | **Пример** | **Проблема** | **Лучший пример** | | Выполнено | Без описания | Операция завершена | | | operatorName | Строчная буква и без пробела | Имя оператора | Оператор. В следующих разделах приведены более подробные рекомендации для конкретных элементов. --- ## Переменные Имена переменных должны быть уникальными для приложения, однако в рамках платформы Tulip можно повторно использовать одни и те же имена. - Тип переменной не должен включаться в имя - Сокращения единиц измерения записываются в круглых скобках рядом с именем числовых переменных | | | | | | --- | --- | --- | | | **Пример** | **Проблема** | **Лучший пример** | | Total wgt | Аббревиатура и единицы измерения. Для регулируемых отраслей см. комментарий ниже. | Общий вес (г) | | fltTemperatureF | Введите название, без пробела и в неправильных единицах измеренияДля регулируемых отраслей см. следующий подраздел | Температура (°F)| ### Регулируемые отрасли Рекомендуется хранить значение и его единицу измерения в двух отдельных полях переменных/записей таблицы, например, "Общий вес" и "Общий вес_UOM". Дополнительную информацию см. в разделе "Лучшие практики создания приложений GxP". | | | | | | --- | --- | --- | --- | | **Пример** | **Проблема** | **Лучший пример** | | Температура (°F) | Только одна переменная используется для значения и единицы измерения | Температура Temperature_UOM | ### Переменные, используемые для фильтрации таблиц Переменные, используемые для фильтрации таблицы по определенному столбцу, следует называть с префиксом 'Filter'. Это повышает удобство использования таких переменных при создании приложений. Это рекомендуется для переменных, используемых исключительно для фильтрации. Переменные общего назначения в приложениях не нуждаются в префиксе. | | | | | | --- | --- | --- | --- | | **Пример** | **Проблема** | **Лучший пример** | | Фильтр состояния | Суффикс без | Filter_Status | | Фильтр IPCtimestamp | Суффикс против префикса В нижнем регистре и без пробела | Filter_IPC Timestamp | ### Переменные для ключевых показателей Для приложений с ключевыми показателями, например, CPPs/CQAs (Critical Process Parameters / Critical Process Attributes) или KPIs, добавьте префикс к именам переменных, чтобы улучшить их читабельность. | | | | | | --- | --- | --- | | | **Пример** | **Проблема** | **Лучший пример** | | CPP Temperature | Префикс не четко отделен от имени переменной | CPP_Temperature (°C) | | AssayB_CQA | Используйте суффикс вместо префикса | CQA_Assay B | | Availability | Отсутствует префикс для ключевого показателя | KPI_Availability|. --- ## Таблицы Имена таблиц должны соответствовать тому же соглашению об именовании, которое используется для переменных, и должны быть сгруппированы с префиксом. Таблицы должны быть сгруппированы по общему назначению, например, для нескольких/всех случаев использования, или для конкретных случаев использования. Рекомендуется использовать ' ## ' для группировки общего назначения и не использовать '*'. Символ '*' используется компанией Tulip для маркировки таблиц, созданных в библиотеке Tulip Apps. | | | | | | --- | --- | --- | | | **Пример** | **Проблема** | **Лучший пример** | | Печатная таблица lables_table | Использование суффикса | #Printed Labels | | *Printed_labels | Использование префикса '*' | #Printed Labels | --- ## Триггеры Не рекомендуется использовать стандартное имя "безымянного триггера". Вместо этого имя триггера должно в нескольких словах описывать его функциональность. | | | | | | --- | --- | --- | | | **Пример** | **Проблема** | **Лучшее имя** | | Неназванный триггер | Имя по умолчанию | Увеличение счетчика дефектов | | Проверка статуса | Слишком мало контекста | Проверка статуса доставки заказа |