描述类定义的结构。
介绍一个类可以包含熟悉的类元素,如属性、方法和参数(在其他类语言中称为常量)。它还可以包含通常不在类中定义的项,包括触发器、查询和索引。
详细类定义具有以下结构:
Import import_ppackage_list
Include include_code
IncludeGenerator include_generator_code
/// description
Class package.shortclassname Extends superclass_list [ class_keyword_list ]
{
Class_members
}
-
import_package_list
(可选)指定类从中导入的任何包的名称。会影响编译器解析短类名的方式。
如果指定了此选项,则它可以是单个包的名称,也可以是多个包的逗号分隔列表,用括号括起来。
如果import_package_list
为空,则不要在类定义的开头添加import
行。
注意:如果一个类导入任何包,该类不会自动导入用户包。
导入的包继承自所有超类。如果一个子类指定了一个或多个导入包,这些导入包将被添加到由超类定义的任何导入包中。
-
include_code
(可选)指定include (.inc)
。编译此类时使用的文件。
如果指定了此选项,则它要么是单个包含文件的名称(没有.inc
扩展名)或是多个包含文件的逗号分隔列表,用括号括起来。
如果include_code
为空,则忽略类定义开头的include
行。
包含文件继承自所有超类。如果子类指定了一个或多个包含文件,这些文件将被添加到由超类定义的任何包含文件中。
-
include_generator_code
(可选)指定include (.inc)
。编译该类的生成器方法时使用的文件。
如果include_generator_code
为空,则不要在类定义的开头添加IncludeGenerator
行。
-
description
描述(可选)旨在显示在“类参考”中。描述可以由多行组成,并且可以包括HTML
格式标记和附加标记,例如class>
和<method>
。默认情况下,描述为空白。 -
package
包(必需)是有效的包名。 -
shortclassname
(必需)是有效的类名。package
和shortclassname
一起构成完整的类名,该类名受长度限制。 -
superclass_list
(可选)指定此类继承的一个或多个类。如果指定了此选项,则它要么是单个类的名称(没有.cls
扩展)或是用逗号分隔的类列表,用括号括起来。
第一个这样的类被称为主超类;任何额外的类都是次级超类。
如果超类列表为空,则从类定义中省略单词Extends
。
-
class_keyword_list
(可选)是以逗号分隔的关键字列表,这些关键字(在大多数情况下)会影响编译器如何为此类定义生成代码。
如果省略此列表,也要省略方括号。
-
Class_members
是类成员的零个或多个定义。