previous | start | next

## Function Comments

- We must comment every function, even if it seems silly.
- Comments are for human readers, not compilers.
- There is no universal standard for comment layout, but this book uses the javadoc style.
  - An `@param` entry explaining each parameter
  - An `@return` entry describing the return value
- Comments do not explain the implementation, but the idea.
- Writing comments first, before writing the function code, to test your understanding of what you need to program.

previous | start | next