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

submitted 1 year ago* (last edited 1 year ago) by spartanatreyu@programming.dev to c/programming@programming.dev

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.

you are viewing a single comment's thread
view the rest of the comments

[-] EthicalAI@beehaw.org 2 points 1 year ago

That right there is a masterclass. Thanks

this post was submitted on 22 Jun 2023

18 points (100.0% liked)

Programming

17314 readers

252 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 !webdev@programming.dev

founded 2 years ago

MODERATORS

snowe@programming.dev

Ategon@programming.dev

MaungaHikoi@lemmy.nz