• Doc Avid Mornington
      link
      fedilink
      English
      610 months ago

      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.

      • @funkless_eck
        link
        510 months ago

        ticket is too exposed, what if they reverse engineer the name? just use t2387ac3 instead it saves time

    • @[email protected]
      link
      fedilink
      210 months ago

      My coworkers do document the code:

      /// Returns a list of foos, given a bar. 
      fn get_foos_from_bar(bar: Bar)