-
Notifications
You must be signed in to change notification settings - Fork 14
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
Labels
enhancement
New feature or request
Comments
i prefer use JSdocs since it already document the code |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
TS to JsDoc conversion
The text was updated successfully, but these errors were encountered: