search

microsoft / advanced-formula-environment

Create, edit, and reuse formulas in Excel
https://aka.ms/get-afe
MIT License
113 stars 11 forks source link

Feature Request: add (IntelliSense) argument descriptions #74

Open Mo-Gul opened 10 months ago

Mo-Gul commented 10 months ago

As I have learned at https://github.com/microsoft/Excel-Labs/issues/10 it is already possible to have IntelliSense help for the function. Would it be possible to add argument descriptions to module functions (Modules) as well (as it can be done in VBA with MacroOptions? Maybe this can be done with some sort of special comment like 

/**
I am the function description.
@Arg("I am the description of the first argument.")
*/
jack-williams commented 9 months ago

Thanks for the feedback. This is similar to (but not the same as) #21, so I will leave this up as an enhancement.

By IntelliSense, do you mean the Excel formula bar, rather than AFE?

Unfortunately, there is currently no way via the office-js API to register argument descriptions and have them appear in tooltips.

On the syntax, I think we might go with something like JSDoc, if we did implement this, but no real commitments yet.

Mo-Gul commented 9 months ago

With IntelliSense I mean the "tooltips" which show up, when you start writing a formula in a cell, but of course having the function and argument descriptions elsewhere too would be a nice bonus.

To be even more explicit: I mean the stuff shown in the screenshots at https://github.com/Excel-DNA/IntelliSense#example.