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

comments can be written in NatSpec for better DX #60

Open
0xStrobe opened this issue Jul 25, 2023 · 0 comments
Open

comments can be written in NatSpec for better DX #60

0xStrobe opened this issue Jul 25, 2023 · 0 comments

Comments

@0xStrobe
Copy link

croc's contracts are fairly abstract, so devs often need to jump in and follow the source code to understand how many of the features work

although well documented, i think its better to format comments into the NatSpec standard, so the comments can be picked up by toolings automatically. for example, etherscan injects the comments into the "contract ui" for all documented public methods, vscode shows the entire comments on hover, and docs can be auto generated as well

not sure if etherscan allows reverifying contract source code

currently, the comments start with /*

image image

vs

image
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