A breakdown of how the Redis source code got comments right.

Syndicated from the fediverse. Read and engage on the original instance.

A breakdown of how the Redis source code got comments right.

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.

http://antirez.com/news/124Open link View original on programming.dev

Comments3

3 replies

Scott

sh.itjust.works

This site doesn't support HTTPS

spartanatreyu reply

programming.dev

Oh damn, you're right. It's sending an outdated certificate.

Here's a secure link: https://web.archive.org/web/20230607041256/http://antirez.com/news/124

EthicalAI

beehaw.org

That right there is a masterclass. Thanks