Andromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 years agoHow programmers comment their codelemmy.dbzer0.comimagemessage-square26linkfedilinkarrow-up115arrow-down11file-text
arrow-up114arrow-down1imageHow programmers comment their codelemmy.dbzer0.comAndromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 years agomessage-square26linkfedilinkfile-text
minus-squareMartin@feddit.nulinkfedilinkarrow-up1·2 years agoComments should explain “why”, the code already explains “what”.
minus-squarecalcopiritus@lemmy.worldlinkfedilinkarrow-up1·2 years agoInline comments yes. Function/Class/Module doc comments should absolutely explain “what”.
minus-squareMartin@feddit.nulinkfedilinkarrow-up0·2 years agoYou are absolutely right. It was inline comments I had in mind.
minus-squareMartin@feddit.nulinkfedilinkarrow-up0·2 years agoAbsolutely, although I see that as part of why Why is there a horrible hack here? Because stupid reason…
minus-squarelad@programming.devlinkfedilinkEnglisharrow-up0·2 years agoOr if the what is so cryptic and esoteric that it would require the reader a couple hours of research to understand it. Also, I find it useful to summarise the what before code blocks if that can’t be summarised in a function name
Comments should explain “why”, the code already explains “what”.
Inline comments yes.
Function/Class/Module doc comments should absolutely explain “what”.
You are absolutely right. It was inline comments I had in mind.
deleted by creator
Absolutely, although I see that as part of why
Why is there a horrible hack here? Because stupid reason…
Or if the what is so cryptic and esoteric that it would require the reader a couple hours of research to understand it.
Also, I find it useful to summarise the what before code blocks if that can’t be summarised in a function name