郁金香元素命名最佳实践

目的

回顾我们为 Tulip 中自定义元素命名的最佳实践，作为您自己的应用程序和命名惯例的起点。

Tulip 中的所有自定义命名元素（如变量、步骤、记录等）的命名方式都应使其具有可读性、明确性和易懂性，以促进应用程序在生命周期内的可用性。

建议对所有元素采用以下通用命名规范：

• 描述性名称
• 单词全写，无缩写
• 每个单词的第一个字母大写，后面的字母小写
• 单个词之间用空格隔开

| | | | --- | --- | | |示例|问题|更好的 示例| | 完成 | 非描述性 | 操作完成 | | 操作员名称 | 小写且无空格 | 操作员名称 | | 操作员名称

以下部分概述了针对特定元素的一些更详细的指导原则。

变量

变量名称必须在应用程序中唯一，但相同名称可在 Tulip 平台中重复使用。

• 名称中不包括变量类型
• 单位缩写写在数字变量名称旁的括号内

| 示例|问题|更好示例| 总重量 | 缩写和单位。| 总重量 (g) | | fltTemperatureF | 输入名称，不要空格和错误的单位。

受管制行业

建议在两个独立的变量/表记录字段中存储一个值及其计量单位，例如 "总重量 "和 "总重量_UOM"。有关详细信息，请参阅 GxP 应用程序构建最佳实践。

| | | | --- | --- | | |示例|问题|更好的 示例| | 温度 (°F) | 值和计量单位只使用一个变量 | 温度 Temperature_UOM | |

用于过滤表的变量

用于过滤表中特定列的变量应使用前缀 "Filter "命名。这样可以提高这些变量在应用程序构建过程中的可用性。建议仅用于过滤的变量使用这种命名方式。应用程序中的通用变量不需要前缀。

| | | | --- | --- | | |示例|问题|更好的 示例| | 状态过滤 | 不带前缀的后缀 | Filter_Status | IPC 时间戳过滤 | 后缀与前缀的对比 小写且不留空格 | Filter_IPC 时间戳

关键指标变量

对于具有关键指标（如 CPP/CQAs（关键过程参数/关键过程属性）或 KPI）的应用程序，请在变量名后添加前缀，以提高变量的可读性。

| 示例|问题|更好的示例| | CPP Temperature | 前缀与变量名未明确分开 | CPP_Temperature (°C) | AssayB_CQA | 使用后缀而非前缀 | CQA_Assay B | Availability | 关键指标缺少前缀 | KPI_Availability

表

表名应采用与变量相同的命名规则，并用前缀分组。表应按一般用途（如多个/所有用例）或特定用例分组。建议使用

'用于通用分组，而不要使用'*'。Tulip使用'*'来标记来自Tulip库应用程序的表格。

| | | | --- | --- | |示例|问题|更好的 示例| | Printed lables_table | 使用后缀 | #Printed Labels | | *Printed_labels | 使用'*'前缀 | #Printed Labels

触发器

不建议使用默认的 "未命名触发器 "名称。相反，触发器的名称应该用几个词来描述其功能。

| | | | --- | --- | |示例|问题|更好的名称| | 未命名触发器 | 默认名称 | 增加缺陷计数器 | 检查状态 | 上下文太少 | 检查订单交付状态 | 检查缺陷计数器 | 增加缺陷计数器 | 检查状态 | 上下文太少 | 检查订单交付状态 | 下文太少