ABAP 对象中的命名规则

前言

在 SAP 中进行开发，一个不得不面对的现实就是数据字段和 SAP 对象不利用理解，因为所有这些对象最初都是用德语创建的，因此许多缩写在英语中没有任何意义。举个例子：

• VTWEG - Vertriebsweg 分销渠道
• KUNAG - Kunde Auftraggeber 客户
• VKORG - Verkaufsorganisation 销售组织
• LIFNR - Lieferant 供应商

在类生成器中创建的全局类和接口被存储在类库中，并由版本库管理。它们与所有其他版本库对象（数据库表、结构、数据元素等）属于同一个命名空间。因此，有必要为对象类型及其组件制定命名规则，并在程序开发中统一使用。

通用规则：

• 变量名可以使用字符、数字和 _
• 用于变量状态和对象类型的两个字符
• 局部变量以 L 开头（Local）
• 全局变量以 G 开头（Global）
• 函数输入参数以 I 开头（Import）
• 函数输出参数以 E（Export）开头
• 结构符号为 S（Structure）
• 表符号为 T（Table）

全局变量示例：

data: gv_temp type string.
data: gs_temp type sy.
data: gt_temp type table of sy.

局部变量示例：

data: lv_temp type string.
data: ls_temp type sy.
data: lt_temp type table of sy.

组件的命名空间

一个命名空间是由以下方面共享的：

• 类本身的所有组件（属性、方法、事件、构造函数、接口、类中的内部数据类型和别名）。
• 该类的超类的所有公共和保护组件。

方法的实现使用一个局部命名空间。本地变量的名称可以掩盖类组件的名称。

当你为开发对象选择名称时：

• 使用英文名称

• 尽可能使用词汇表中的术语
  例如，用 CL_COMPANY_CODE 而不是 BUKRS 。

• 在复合名称中，使用下划线字符（_）作为分隔符。由于名称不区分大小写，这是唯一可以用来分隔名称的字符。
  例如，CL_COMPANY_CODE，CL_GENERAL_LEDGER_ACCOUNT。

• 名称应该描述动作，而不是动作的实现
  例如，PRINT_RECTANGLE，而不是 RECTANGLE_TO_SPOOL

对象类型的约定

在命名空间之后，使用 CL、IF 或 CX。类的名称应该是一个名词，并描述它维护的对象。如果可能，尽量不要使用缩写。我们将主要保留这些类的类型。例如，实用程序类以 UTIL 结尾，服务类以 SRV 结尾。

类库中的类和接口名称与数据元素、表、结构和类型属于同一个命名空间。它们被集中在表 TADIR 中维护。

组件/方法的约定

具体方法描述

方法应该描述一个动作，正在发生的事情。它通常包含一个动词（或应始终包含一个动词）。GET 和 SET 方法访问私有成员属性，而 READ 应仅用于从数据库层中选择数据。如果某个方法返回布尔值，则以 IS/ARE 启动该方法

例如：

IF is_flight_scheduled( iv_connid = iv_connid 
                        iv_carrid = iv_carrid 
                        iv_fldate = sy-date 
                      ).
"Create new flight 
ENDIF.

方法中的局部约定

对于参数，这些参数是从实现它们的方法的角度来看待的：

使用前缀并不是强制性的，但如果你决定使用前缀，请只使用上面列出的那些。

异常的命名规定

下表包含了一系列可能的异常名称，这些名称也可以通用（例如，NOT_FOUND 也可以作为DATE_NOT_FOUND 使用）。