• Rinox@feddit.it
    link
    fedilink
    arrow-up
    5
    ·
    1 year ago

    Yeah, proper documentation is not done with comments in code, but it’s a project in and of itself. Proper documentation is also fucking hard and I have no idea how people (in open source projects) can do it. It’s so fucking boring and tedious, especially when there are a million interesting problems you could tackle instead. Mad respect for people writing documentation, seriously.

    I also hate writing comments and prefer to just write out everything in code.

    • anti-idpol action@programming.dev
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      yep. Good code is self-documenting and syntax highligting and having longer sections folded up may help more than having to process some greyed out text. But comments are still useful for generating proper autocompletion and avoiding having to skim through you '“self documenting code”. Also it helps greatly with TDD and maintaining good coding practices. For example if you need a numbered list to reliably sum up what some function does, it’s often a good sign that it should be broken into a couple smaller ones.