Document.createComment(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Creates a Comment node of type COMMENT_NODE with the specified string.
Returns	xml.Node
Supported Script Types	Client and server scripts For more information, see SuiteScript 2.x Script Types.
Governance	None
Module	N/xml Module
Since	2015.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description
options.data	string	required	Data for the Comment node.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/xml Module Script Samples.

          //Add additional code 
...
var newNode = xmlDocument.createComment({
    data : 'This is a comment.'
});
...
//Add additional code 

        

Related Topics

xml.Document

N/xml Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices