Andromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 years agoHow programmers comment their codelemmy.dbzer0.comexternal-linkmessage-square37linkfedilinkarrow-up157arrow-down10file-text
arrow-up157arrow-down1external-linkHow programmers comment their codelemmy.dbzer0.comAndromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 years agomessage-square37linkfedilinkfile-text
minus-squareMartin@feddit.nulinkfedilinkarrow-up4·2 years agoComments should explain “why”, the code already explains “what”.
minus-squaresmeg@feddit.uklinkfedilinkEnglisharrow-up3·2 years agoThe allowable exception is when the what is a what the fuck, as in you had to use a hack so horrible that it requires an apology comment
minus-squarecalcopiritus@lemmy.worldlinkfedilinkarrow-up1·2 years agoInline comments yes. Function/Class/Module doc comments should absolutely explain “what”.
Comments should explain “why”, the code already explains “what”.
The allowable exception is when the what is a what the fuck, as in you had to use a hack so horrible that it requires an apology comment
Inline comments yes.
Function/Class/Module doc comments should absolutely explain “what”.