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

Add additional in-line and NatSpec comments #5

Open
mgcolburn opened this issue Apr 23, 2020 · 0 comments
Open

Add additional in-line and NatSpec comments #5

mgcolburn opened this issue Apr 23, 2020 · 0 comments

Comments

@mgcolburn
Copy link

Add additional in-line and NatSpec comments

Type: Code Quality
Target: Throughout

Description

Solidity is often annotated using NatSpec comments (https://solidity.readthedocs.io/en/v0.5.11/natspec-format.html). There are a lot of optional tags you can include or not as you see fit, but it could make for a nice place to start for improving code documentation. The function descriptions in the accompanying README on Github could almost be copied in directly. Additionally, more in-line comments would be nice to see, especially around some of the denser arithmetic in the code.

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