Good code is its own best documentation.
–Steve McConnell

More info

This post is created by a bot. If you want to contribute to this community, please take a look at the sidebar

  • FlickOfTheBean@lemmy.world
    4·
    1 year ago

    Sure, but please don’t skip the actual documentation either lol

    Sometimes I just want a list of inputs and outputs and I don’t want to read through the source to find them.

    I wonder how many perfect plugins I’ve passed over for the lack of decent documentation by now

  • philwills@programming.dev
    1·
    1 year ago

    Often, the documentation explains the why… The code (without documenting comments of course) only every tells you how…