Andromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 months agoHow programmers comment their codelemmy.dbzer0.comimagemessage-square25fedilinkarrow-up138arrow-down10file-text
arrow-up138arrow-down1imageHow programmers comment their codelemmy.dbzer0.comAndromxda 🇺🇦🇵🇸🇹🇼@lemmy.dbzer0.com to Programmer Humor@programming.devEnglish · 2 months agomessage-square25fedilinkfile-text
minus-squareMartin@feddit.nulinkfedilinkarrow-up3·2 months agoComments should explain “why”, the code already explains “what”.
minus-squaresmeg@feddit.uklinkfedilinkEnglisharrow-up2·edit-22 months 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 months 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”.