search

Encode-Solidity-Bootcamp-Group-10 / Week1

0 stars 0 forks source link

Comments: consistent commenting, unused code and Radspec #3

Open Super-Nim opened 2 years ago

Super-Nim commented 2 years ago

There are intermittent comments in the script files. it's best to comment EVERYTHING to drill the purpose of each constant, object, provider, etc. accomplishes into our minds. Although it may seem tedious, repetition is key to success 🔑

Some files have NO comments at all - let this be a thing of the past.

Intermittent commenting:

Screenshot 2022-07-09 at 12 12 33

Also, l've noticed unused/commented out code left behind. Let's keep it clean and avoid this when possible.

unused code:

Screenshot 2022-07-09 at 12 12 51

We haven't been commenting on our smart contracts at all. I also propose that we implement Radspec in our Smart Contracts from now on too.

danisev7 commented 2 years ago

I totally agree to improve the documentation. We should open some pull requests to update the documentation to the NatSpec Format and Radspec