Custom Function - add comment

hogi — Sat, 18 Jan 2025 07:30:11 GMT

Some of the examples in the Scripting Index have lots of details and useful comments:

When a user submits a function via Add custom Function(), such comments are automatically removed:

What do I have to do to see the comments?

Add Custom Functions(
	New Custom Function(
		"test",
		"f",
		Function( {}, Print( "hello world" )
		),
		<<Description( "test function" ),
		<<Example(
			Expr(
			x=3;
		// here I want to add a comment which will be displayed in the scripting index
				f()
			)
		)
	)
);

Re: Custom Function - add comment

jthi — Sat, 18 Jan 2025 07:59:07 GMT

Usually JSL Quote() can help with these type of situations. Additional benefit is that you don't have to use strings when building your functions

Names Default To Here(1);
myAdd = New Custom Function(
	"custom",
	"Add",
	Function({x, y = 1},
		x + y - 1
	)
);
myAdd << Example(JSL Quote(// add first to second
	a = Add(1, 2);
	Show(a); // a = 3;
));

Add Custom Functions(myAdd);

topic Custom Function - add comment in Discussions

Custom Function - add comment

Re: Custom Function - add comment