Using Comments in the PCF Editor
The PCF editor supports comments. It also has special Description <desc> and Tag <tag> comments that can be used in tooltips.
New functions will come with the function description comment pre-loaded at the top of the function, this comment type is preceded by three forward slashes "///"
You can also auto-populate these tags by pressing the forward slash key 3 times "///" at the top of a blank editor window
Simply type your function description between the description opener <desc> and description closer </desc>, in this example we have created a function called DescriptionExample and inserted a place holder formula
When you add a parameter it will automatically include description tags, parameter descriptions are placed to the right of the parameter and are preceded by three forward slashes "///"
Simply type your description between the description opener <desc> and description closer </desc> tags, in this example we have created a parameter called span and used it in a formula to find the maximum close value of the last N bars, N is defined by the Span parameter. The parameter description is now included in the tool-tip for that parameter
Parameter descriptions will also show when used in functions, here we have saved that same formula "MAXC#Span" as a function titled #MaxClose. When we call the function and open a parentheses to assign a value to the #Span parameter the description is shown in the tool tip
Parameter descriptions must be placed directly to the right of a parameter, be preceded by three forward slashes "///" and be enclosed in opening and closing description tags