- Document the purpose of the code
- Document the why rather than the how
- If you need to violate good programming style, explain why in the code.
- Comment before writing code
- Use solid-character comment lines only for major comments
- Avoid creating comment boxes
- Give each procedure a comment header
Purpose
Accepts
Returns - Document code processes by using inline comments
Tuesday, November 22, 2005
Commenting Code
Subscribe to:
Post Comments (Atom)
No comments:
Post a Comment