SuiteScript 2.0 脚本剖析

所有 SuiteScript 2.0 入口点脚本必须符合相同的基本结构。下图对该结构进行了说明。有关脚本的编号组件的说明，请参见图表后面的表格。

 

 

常规区域	标注	说明
0 – JSDoc 标记	2 和 3	@NapiVersion 标记（在入口点脚本中是必需的）及其值。有效值为 2.0、2.x 和 2.X。
	4 和 5	@NScriptType 标记（在入口点脚本中是必需的）及其值。该值不区分大小写，但建议使用 Pascal 命名法以提高可读性，如此示例中所示。
1 – define 语句	6	define 函数的第一个参数，它是依赖项列表，或脚本加载的模块列表。此脚本使用 N/record 模块（允许脚本与记录交互）和 N/ui/serverWidget 模块（允许脚本与表单交互）。
	7	define 函数的第二个参数，它是一个回调函数。
	8	回调函数的参数。第一个参数是表示 N/record 模块的对象。第二个表示 N/ui/serverWidget 模块。这些对象的序列与 define 函数的依赖项列表（标注 6）的序列相匹配。 可以在回调函数中的任何位置使用这些对象来访问这些模块的 API。您可以为这些对象指定您喜欢的任何名称。作为最佳实践，请使用与模块名称类似的名称。
	9、10 和 11	入口点函数。对于要使用的任何函数，必须在 return 语句中与入口点一起命名，如标注 17 所示。
	12、13 和 14	提供给每个入口点函数的上下文对象。这些对象的特征因入口点而异。有关这些对象的解释，请参阅传递至标准入口点和自定义入口点的上下文对象。
	15	回调函数的 return 语句。
	16	脚本使用的入口点。必须至少使用一个入口点。在入口点脚本中，使用的任何入口点都必须属于 @NScriptType 标记（标注 4 和 5）标识的脚本类型。
	17	对脚本的入口点函数的引用。对于使用的每个入口点，脚本必须标识在脚本中其他位置定义的入口点函数。