Skip to content

Latest commit

 

History

History
25 lines (20 loc) · 712 Bytes

Comments.md

File metadata and controls

25 lines (20 loc) · 712 Bytes

11 - Comments

Single-line comments (//) and multi-line comments (/*...*/) are possible.

Comments are recommended as in-line documentation of what contracts, functions, variables, expressions, control and data flow are expected to do as per the implementation, and any assumptions/invariants made/needed.

They help in readability and maintainability.

Slide Screenshot

011.jpg

Slide Deck

  • Inline Comments
  • Single Line: //
  • Multi-line: /* .. */
  • Implement -> Documentation
  • Assumptions/Invariants
  • Affects
    • Readability
    • Maintainability

References