Skip to content

Latest commit

 

History

History
24 lines (21 loc) · 776 Bytes

Comments.md

File metadata and controls

24 lines (21 loc) · 776 Bytes
Raw

154 - Comments

Ensure that the code is well commented both with NatSpec and inline comments for better readability and maintainability.

The comments should accurately reflect what the corresponding code does.

Stale comments should be removed. Discrepancies between code and comments should be addressed.

Any TODO’s indicated by comments should be addressed. Commented code should be removed.

Slide Screenshot

0154.jpg

Slide Text

  • Code Comments Documentation
  • Inline & Natspec
  • Details & Relevance
  • Readability & Maintainability
  • Sync: Code <-> Comment
  • Sufficient Comments

References

Tags