• Zagorath
    link
    fedilink
    arrow-up
    8
    arrow-down
    2
    ·
    1 year ago

    Comments explain why, not what. Any comments that explain what a section of code is doing would probably be better off as separated methods.

    Apart from basic documentation comments, like JavaDoc or C#'s XML documentation comments.

    • SpeakinTelnet@programming.dev
      link
      fedilink
      arrow-up
      4
      ·
      1 year ago

      There’s nothing limiting what a comment should be as far as I know.

      As an example of what I mean, I’ve seen in a 10k+ lines python code a few lines of bit manipulation. There was a comment explaining what those lines did and why. They didn’t expect everyone to be proficient in bit manipulation but it made it so that anyone could understand anyway.

      • Zagorath
        link
        fedilink
        English
        arrow-up
        2
        ·
        1 year ago

        There’s nothing limiting what a comment should be as far as I know.

        Nothing technical, sure. Just good coding practices.