Comments: When Needed, When They Lie
This generated surface maps a learner-facing curriculum unit to its canonical source routes.
Curriculum surface
- Open learner-facing unit
- Curriculum path:
content/curriculum/foundations/semester-03-software-design/module-01-ood-foundations-and-smells/concepts/cluster-03-naming-functions-and-readability/11-comments-when-needed-when-they-lie-supporting.md - App:
foundations - Semester:
semester-03-software-design - Module:
module-01-ood-foundations-and-smells - Unit kind:
concept - Curation level:
generated_default
Learning objectives
- Explain Comments: When Needed, When They Lie in the language of the current curriculum, not just the source book.
- Apply Comments: When Needed, When They Lie to one concrete learner task or example inside this semester.
- Use
clean-code,good-code-bad-code,refactoringas a selective source of truth when the learner-facing explanation is not enough.
Prerequisites
- The earlier concept pages and practice tasks in the current module.
Source books
clean-codegood-code-bad-coderefactoring
Source routes
Clean Code
- /books/clean-code/chapter-04-comments-comments-do-not-make-up-for-bad-code-to-e via
Clean Code: Comments do not make up for bad code - /books/clean-code/chapter-04-comments-don-t-use-a-comment-when-you-can-use-a-fu via
Clean Code: Don't use a comment when you can use a function - /books/clean-code/chapter-04-comments-redundant-comments-to-scary-noise via
Clean Code: Redundant comments to scary noise
Good Code Bad Code
- /books/good-code-bad-code via
Good Code, Bad Code: Use comments appropriately
Refactoring
- /books/refactoring via
Refactoring: Data class and comments
Supporting curriculum routes
No supporting curriculum routes linked yet.
External enrichment
No curated enrichment resources yet.
AI companion modes
- Explain simply
- Socratic tutor
- Quiz me
- Challenge my understanding
- Diagnose my confusion
- Generate extra practice
- Revision mode
- Connect forward / backward
Source-of-truth note
This teaching unit is learner-facing guidance assembled from multiple canonical book routes. Use the listed source books as the primary conceptual spine for Comments: When Needed, When They Lie, and treat outside material as supporting enrichment only.