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

Generate comments automatically for a function in solidity #296

Closed
meanking opened this issue Nov 28, 2022 · 1 comment · Fixed by #359
Closed

Generate comments automatically for a function in solidity #296

meanking opened this issue Nov 28, 2022 · 1 comment · Fixed by #359
Labels
status:ready This issue is ready to be worked on type:feature New feature or request

Comments

@meanking
Copy link

Hi

I would like to suggest you support the auto-comment generation feature for solidity extension.

For example:
let's assume we have this function.

function setAdmin(address _admin, bool _enabled) external onlyOwner {
        _admins[_admin] = _enabled;
        
        emit SetAdminAccess(true);
    }

Then I want to have a comment skeleton like this when I write /** and press enter.

/**
     * @notice
     *
     * @param _admin
     * @param _enabled
     */

I think this is possible because you are providing this for javascript/typescript already.

Looking forward to hearing from you.

Best regards,
Meanking

@kanej kanej added the type:feature New feature or request label Nov 28, 2022
@kanej
Copy link
Member

kanej commented Nov 29, 2022

That is a great suggestion.

We are focused on vim.coc support right now, but we will be looking generally at how we deal with comments in the new year.

@kanej kanej moved this to In Progress in hardhat-vscode Jan 2, 2023
@kanej kanej added the status:ready This issue is ready to be worked on label Jan 2, 2023
@antico5 antico5 moved this from In Progress to Done in hardhat-vscode Jan 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status:ready This issue is ready to be worked on type:feature New feature or request
Projects
Status: Done
2 participants