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

Enable intellisense in IDE #63

Open
vitorgamer58 opened this issue May 13, 2023 · 1 comment
Open

Enable intellisense in IDE #63

vitorgamer58 opened this issue May 13, 2023 · 1 comment
Labels
enhancement New feature or request

Comments

@vitorgamer58
Copy link

vitorgamer58 commented May 13, 2023

Is your feature request related to a problem? Please describe.
One problem is that herbsJs doesn't have type declaration files or JsDocs, which means we don't have intellisense in any of the libs or glues.

Describe the solution you'd like
We can insert .d.ts type declaration files to enable intellisense, at the same time these files become documentation.
This makes it easier to know which methods can be called and what they return.

Describe alternatives you've considered
We can also use DefinitelyTyped, where we can leave the type declarations in a separate repository, example: @types/herbs

Or add a JsDocs header to the functions we want to document.

Additional context
Example:
Screenshot_512
Screenshot_514

TS to JsDoc conversion

@vitorgamer58 vitorgamer58 added the enhancement New feature or request label May 13, 2023
@italojs
Copy link
Member

italojs commented May 16, 2023

i prefer use JSdocs since it already document the code
we could use it to auto-generate a low level documentation

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