Over Commenting

Flag comments that explain what self-documenting code already says.

kubernetes-sigs Updated 3.2k repo stars

File contents

Skill: Over-commenting

Over-commenting — comments that explain what self-documenting code already says. A well-named function does not need a comment restating its name in prose.

kubernetes-sigs/kueue commit a928f8f970

Frequently asked questions

npx get-skill add kubernetes-sigs-kueue/over-commenting