This very old post has the best advice on code comments I've ever seen. It analyzes a sample of Redis source files, classifies the comments, explains why they are effective, and draws advice on how to comment.
https://antirez.com/news/124
#programming
Paolo Amoroso
npub1sy…m8vde
2024-12-26 11:59:01 UTC
Author Public Key
npub1sy08l0jqgsysgmx82k2zdaf9lfwqm8vjg78zjf3da5rs63hq9m5swm8vdeSeen on
wss://relay.momostr.pinkPublished at
2024-12-26 11:59:01 UTCEvent JSON
{
"id": "7cb9d7d9d62ec12da56d712894ffb376e5520646608ecfdbe145eff04be11cfd",
"pubkey": "811e7fbe404409046cc7559426f525fa5c0d9d92478e29262ded070d46e02ee9",
"created_at": 1735214341,
"kind": 1,
"tags": [
[
"proxy",
"https://fosstodon.org/@amoroso/113719007089097046",
"web"
],
[
"t",
"programming"
],
[
"proxy",
"https://fosstodon.org/users/amoroso/statuses/113719007089097046",
"activitypub"
],
[
"L",
"pink.momostr"
],
[
"l",
"pink.momostr.activitypub:https://fosstodon.org/users/amoroso/statuses/113719007089097046",
"pink.momostr"
],
[
"-"
]
],
"content": "This very old post has the best advice on code comments I've ever seen. It analyzes a sample of Redis source files, classifies the comments, explains why they are effective, and draws advice on how to comment.\n\nhttps://antirez.com/news/124\n\n#programming",
"sig": "847661302dabb85611fe0355fbb687f356c65baae48d6488a8fddbb31ff7ea74980c330988d68899d2e0cc269d466d77412d1966caf83b325318785d2281ea30"
}