A breakdown of how the Redis source code got comments right. (antirez.com)

submitted 2 years ago* (last edited 2 years ago) by [email protected] to c/[email protected]

3 comments fedilink hide all child comments

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.

top 3 comments

sorted by: hot top new old

[-] [email protected] 1 points 2 years ago

That right there is a masterclass. Thanks

[-] [email protected] 0 points 2 years ago

This site doesn't support HTTPS

[-] [email protected] 1 points 2 years ago

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

this post was submitted on 22 Jun 2023

9 points (100.0% liked)

Programming

21711 readers

248 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Follow the programming.dev instance rules
Keep content related to programming in some way
If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities [email protected]

founded 2 years ago

MODERATORS

[email protected]