Using “self documenting” as a blanket excuse to not document things that need it is inexcusable, yes, but I’d rather work on code written by somebody who seriously thinks about how to make it clean and self documenting, and then documents whatever still needs it as well, than on code written by somebody who doesn’t make that effort, but documents heavily. And as for people who claim they’re documenting everything, when the documentation is function fooTheBar() // foos the bar
, they can eat a bag of docs.
Comment on I love all my statements equally. (I don't care for GOTO)
railsdev@programming.dev 1 year agoiT’s SeLF dOcUmenTiNg 🥴
docAvid@midwest.social 1 year ago
railsdev@programming.dev 1 year ago
100% agree. Sometimes I start a comment and realize I’ve either explained exactly what it’s doing and delete it or just update my variables to be more concise.
My job doesn’t like when I document the parameters and return type/value of methods. I think that that is really important in a dynamic language like Ruby and sets expectations that the method should ONLY return that type.
TheYear2525@lemmy.world 1 year ago
bool ticket2387_ac3 = true; // TODO if (!ticket2387_ac3) return;
funkless_eck@sh.itjust.works 1 year ago
ticket is too exposed, what if they reverse engineer the name? just use t2387ac3 instead it saves time
UnRelatedBurner@sh.itjust.works 1 year ago
facts
hairyballs@programming.dev 1 year ago
My coworkers do document the code:
/// Returns a list of foos, given a bar. fn get_foos_from_bar(bar: Bar)
redcalcium@lemmy.institute 1 year ago
It perfectly makes sense if you think like me.
QuazarOmega@lemy.lol 1 year ago
Aren’t we all?