A breakdown of how the Redis source code got comments right.
A breakdown of how the Redis source code got comments right.
antirez.com
Writing system software: code comments. - <antirez>
Comments should provide context, not repeat what the code already says. The Redis codebase has 9 distinct types of comments (Function, Design, Why, Teacher, Checklist, Guide, Trivial, Debt, Backup), each with a specific goal in mind.