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: autocomplete when documenting jsdoc style #349

Open
shirotech opened this issue Mar 8, 2023 · 0 comments
Open

Feature request: autocomplete when documenting jsdoc style #349

shirotech opened this issue Mar 8, 2023 · 0 comments

Comments

@shirotech
Copy link

shirotech commented Mar 8, 2023

Very good plugin, and it has been making things very easy for us devs.

Just a request would be awesome if it can be considered.

Following the standard that OpenZeppelin on how they structure their documentations in code: e.g. https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/token/ERC20/ERC20.sol

Noticed that it is very similar to jsdoc, and when we are writing javascript in intellij projects, it will auto-complete these jsdoc type as soon after a double asterisk is entered.

For example, in keystrokes: slash-asterisk-asterisk-enter
It will auto-populate:

/**
 * @dev <cursor>
 * 
 * @param <any params here>
 * @return <any return here>
 */

having said that, I think it can be simple for the time being, e.g:

/**
 * @dev <cursor>
 */

Hope this all makes sense. Thank you!

@shirotech shirotech changed the title Feature request: autocomplete when documentingin jsdoc style Feature request: autocomplete when documenting jsdoc style Mar 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant