Script Custom Method - Parameter Documentation

Does anyone know if is possible to document custom method parameters using the script’s comment block?

Ignition automatically inserts the highlighted text (below) into its in-line docs when adding the parameter, but won’t allow me to edit the line to add a parameter comment (similar to the self argument just above it).

Doesn’t seem the comment block is editable directly (I’ve had to add the parameter comment manually below the block).

I also tried to add some comment text into the Parameters entry box but it does not parse.

MicrosoftTeams-image

This isn’t currently possible, but it’s an interesting idea…

Script editor refinements are on the short list of improvements; while this wouldn’t land in that initial round, I could see it coming as a further enhancement - maybe a table for the parameters, where you could also define an expected type and a comment.

5 Likes