C# script component tooltip/ documentation

Grasshopper Developer
,
1

Hello,

I am currently working with simple C# components for which I would like to add a description and parameter information.
In GhPython one has to use the

"""Provides a scripting component.
    Inputs:
        x: The x script variable
        y: The y script variable
    Output:
        a: The a output variable"""

docstring.

The grasshopper C# component seems to be using summary and parameter tags.

2021-01-26 09_31_01-Window
2021-01-26 09_31_01-Window1192×640 84.4 KB

I tried out every position in the component where pasting is possible, but the information is not shown on hover.

Does this only work for C# addins or should it work for script components too/ what am I doing wrong?

Thank you.

2

The C# component does not look at any of the comments in the script. If you want to set the tooltip field of inputs or outputs you must do so directly through code.

I can upload an example later today once I get in front of a proper computer instead of this tablet.

1 Like
3

param management.gh (5.2 KB)

This should work.

1 Like