Comment Transform

Inserts a non-functional comment as a recipe step. Commented steps are ignored during job execution.

Multi-line comments are not supported.

Basic Usage

Depending on how the comment is inserted, the format of the step may vary.

Manually inserted comments:

In the Search panel, enter the following text in the Transformation textbox:

comment

Then, specify a value in the comment textbox.

Pasted comments:

Text values of the following formats can be pasted into the Transformation textbox. These steps are converted to comment transforms:

// This is a comment.

/* This is also a comment. */

Output: Output is unaffected by the comment. Comments are highlighted in a different color in the recipe panel.

Exported comments:

When comments are exported in scripts from the Recipe panel, they are in the following format:

// This is a comment.

Parameters

comment comment: 'This is a comment.'

Token Required? Data Type Description
commentYtransformName of the transform
commentYStringText of the comment to include.

comment

A text value that represents the comment that will appear in the recipe panel and in all exported scripts.

Required?Data Type
YesString

Examples

Was this page helpful? Let us know how we did:

Send feedback about...

Google Cloud Dataprep Documentation