core-contracts icon indicating copy to clipboard operation
core-contracts copied to clipboard

Published 20 hours ago • verified publisher icon near

Thoroughly Comment Smart Contracts

Open damons opened this issue 3 years ago • 1 comments

I believe it would be helpful if each function were thoroughly commented. Each parameter should have clear descriptions, and significant sections of logic should have comments explaining what's happening.

A good example for contract interfaces: https://eips.ethereum.org/EIPS/eip-721

damons avatar Oct 01 '20 15:10 damons

Good point. We definitely lacking some good standard for some contracts. While staking pool contract had a standard described in a NEP, it's currently lacking some guarantees that it should provide. E.g. not panic on account balance.

evgenykuzyakov avatar Oct 26 '20 22:10 evgenykuzyakov