Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: add (IntelliSense) argument descriptions #74

Open
Mo-Gul opened this issue Dec 5, 2023 · 2 comments
Open

Feature Request: add (IntelliSense) argument descriptions #74

Mo-Gul opened this issue Dec 5, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@Mo-Gul
Copy link

Mo-Gul commented Dec 5, 2023

As I have learned at microsoft/Excel-Labs#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
Copy link
Contributor

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.

@jack-williams jack-williams added the enhancement New feature or request label Dec 6, 2023
@Mo-Gul
Copy link
Author

Mo-Gul commented Dec 9, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants