clean-code

Start by renaming variables and functions to be intention-revealing, then break large functions into small single-purpose ones. Replace comments with self-explanatory code, use exceptions instead of return codes, and remove code smells like duplication and needless complexity.

Check that names are searchable and pronounceable, functions do one thing at one abstraction level, and arguments stay under three. Verify error handling uses exceptions, tests follow F.I.R.S.T. principles, and classes obey the single responsibility principle.

Functions should be small, do exactly one thing, and operate at a single level of abstraction. They should have zero to two arguments, descriptive verb names, and no hidden side effects on global state.

Avoid comments that restate what the code already says, explain bad code instead of rewriting it, or serve as position markers and noise. Prefer expressing intent through clear names and structure; reserve comments for legal notes, regex intent, or TODOs.

Clean Code guidance is principle-based and does not replace environment-specific validation, testing, or expert review. Rules like function length or argument counts are heuristics, so judgment is needed for context-specific trade-offs.