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