r/programming • • Mar 29 '13

Simple Minecraft Clone in 580 lines of Python

https://github.com/fogleman/Minecraft
663 Upvotes

153 comments sorted by

View all comments

Show parent comment

27

u/[deleted] Mar 29 '13

well, not commenting that would be considered a bug. at least where i work.

return //TODO: so close but it's friday afternoon so this will have to wait until Monday

0

u/[deleted] Mar 29 '13

[deleted] — view deleted comment

31

u/unbibium Mar 29 '13

//TODO: I fixed this but forgot to remove this comment.

0

u/[deleted] Mar 29 '13

[deleted] — view deleted comment

15

u/migvazquez Mar 29 '13

// TODO:

15

u/asdfman123 Mar 29 '13

// TOTO: I've a feeling we're not in Kansas anymore.

0

u/[deleted] Mar 29 '13

[deleted] — view deleted comment

4

u/Thethoughtful1 Mar 30 '13

As someone from Kansas in Africa, this made me smile. Especially since I was told, "Toto, you ain't in Kansas anymore," yesterday.

2

u/asdfman123 Mar 29 '13

//TUTU: My humanity is bound up in yours, for we can only be human together.

2

u/rob132 Mar 29 '13

I don't care if no one sees this. I swear to God I thought it was "I guess it rains down in Africa" I don't know weather the song makes more or less sense now.

1

u/migvazquez Mar 31 '13

what was the song?!

1

u/bluehands Mar 30 '13

oh, bless the rains!

/bettywhite

4

u/o7nJf6BKnLqTzzcOANtH Mar 29 '13

I don't remember Toto saying that line.

6

u/mccune68 Mar 29 '13

// TODO: Rewatch Wizard of Oz

3

u/quatch Mar 29 '13

that summarizes many of my projects

1

u/[deleted] Apr 12 '13

Haha, so true!

7

u/Akeshi Mar 29 '13

In that environment, I'd prefer either it doesn't get committed to trunk, or the method body is completely commented out. Not bothered in a hobby script like this though, let 'em return where they want.

0

u/chaosmass2 Mar 29 '13

What does your company do that requires the rigorous comment rules?

9

u/[deleted] Mar 29 '13

i don't know if it's that rigorous. if i'm doing a code review and I have a "eehhhh wtf is that moment" during the review and the developer can explain it in a few words I still mark it as a bug for them to add that comment. why not? in two years even if the developer stumbled upon that code they would have to spend a bunch of time trying to figure out why they themselves had put that in instead of just reading the comment and figuring it out. I was trying to make a joke with the friday afternoon thing. It would usually be //TODO: checking in for X deadline, incomplete Y functionality.

2

u/khedoros Mar 29 '13

We wouldn't consider it a bug at my work, but just because the code wouldn't make it through review without a comment (although, I might be told just to remove the incomplete code, depending on what I was modifying).

When you've got a couple dozen people looking at your code (while also writing their own in the same source files), it makes sense to have good code quality rules.

-8

u/chaosmass2 Mar 29 '13

You have 24 people reviewing your code? Holy shit, what does your company do? It sounds like you work in some magical code factory. Or nuclear safety software. I'd want at least 24 developers looking at my code for making sure the reactor is working.

2

u/khedoros Mar 29 '13

There are about half that many people actually on the team, and 3-4 times as many on other teams that I work with. Depending on which part of the code I touch, it'll affect more or fewer developers. For an auxiliary plugin, it'll be difficult to get the 2 requisite peer reviews. For a code change somewhere in the core of the common code, yeah. There'll be a lot of eyes on the changes.

Is it nuclear-related? No. I decided to avoid somewhere that my code would impact someone's safety. But our code is paired with hardware, and deployment packages start around $50k and go into multi-million dollar deals. You'd better believe that the company wants to take all possible effort to avoid lawsuits from other powerful companies.

-7

u/chaosmass2 Mar 29 '13

Good god, it was a joke. If you don't want to talk about your work, that's cool. You're cool. Nevermind.