10

So I did a code review for a colleagues pull request and I've noticed that he hasn't written the PHPDocs for a lot of the classes and functions. One minor thing I wrote is to add the author for the class.

About 2 mins after writing that comment he came over to tell me why should he write the author in the comments when people can just go look at the git commit logs. I was like WTF? I asked why would he do that, his answer was that if there's an issue, we can just use git blame to identify the author. To me that makes no sense as git blame isn't supposed to be used like that.

It's guys like these are the ones who don't document anything whether in an online document or even in code. And they just make work harder for the rest of us.

Comments
  • 4
    Personally, I dislike author comments. As soon as someone changes the code, it's co-authored. And then what? keep adding names to the list of authors? What about after 5 devs touched it? Whoever is the last person touching it is responsible for the entire method/function, all test cases and bugs. I hate fucking wannabe devs that say "it's not my bug, I just simplified one if statement"
  • 3
    How do you think `git blame` is supposed to be used?
Add Comment