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

  • floofloof
    link
    fedilink
    English
    arrow-up
    12
    arrow-down
    1
    ·
    edit-2
    1 month ago

    Why not put the “why” in a comment and save people the job of dredging through old commits and tickets to figure out what the code is for? I’d thank someone for saving me the hassle.

    • ExperiencedWinter@lemmy.world
      link
      fedilink
      arrow-up
      1
      ·
      1 month ago

      In any modern IDE “dredging through old commits” means clicking a single button to see who last changed the line. From there it often makes sense to go look at the PR to see a higher level of what was changed. You cannot include all of that context in a single comment.

    • magic_lobster_party@kbin.run
      link
      fedilink
      arrow-up
      2
      arrow-down
      3
      ·
      1 month ago

      You can also do that if you think it’s useful.

      Going back to the original ticket can offer far more info than what any “why” comment can give. You can see how old it is, if there are any connected tickets, who were involved with it, step by step instructions how to reproduce the bug, etc.