# TODO: Add Comments: 5 Tips for _Winning_ at Code Comments
summary
Five concrete habits: change editor colors or syntax rules so comments are obvious and not ignored, document the why not the what with a short example (escaping backslashes case), prefer clear short paragraphs over brittle one-liners, read comments aloud to catch typos and awkward phrasing, and get reviewers to read comments (novices check clarity, seniors check correctness). The presenter even fixes a requests library theme to make comments visible so stale docs stop misleading.
AI-written summary · about
chapters (5)
related talks
13mOn Readable Code
51mTechnically speaking improve your code documentation
52mTechnically Speaking: improve your code with documentation
22mWrite Prose, Not just programs
28mImproving Your Documentation: A talk for developers who want to write stuff good
26mPractice Makes Perfect: Write Accessible Documentation
01h 24mWriting Documentation - Practices and Theory
20mHow to write software documentation (3 major tips)