Comment from my group project teammate. You don’t need to comment every line lol

  • smeg@feddit.uk
    link
    fedilink
    English
    arrow-up
    3
    ·
    5 months ago

    Exactly! Write your code to be as clear and self-descriptive as possible, and then add a comment if something is still not immediately obvious.

    • Starbuck@lemmy.world
      link
      fedilink
      arrow-up
      5
      ·
      5 months ago

      If I see comments explaining every other line, especially describing “what” instead of “why”, I assume the code was written by a recent grad and is going to be bad. Describing what you are doing looks like you are doing a homework assignment.

      Like on that line, obviously we’re initializing a variable, but why 1 instead of 0? Could be relevant to a loop somewhere else, but I guess I’ll have to figure that out by reading the code anyways.