raganwald / cafeaulife

Gosper’s HashLife in CoffeeScript
30 stars 2 forks source link

get rid of “what” comments #20

Closed raganwald closed 12 years ago

raganwald commented 12 years ago

Some of these comments really seem unnecessary. for example:

# Export `Cell`
_.defaults exports, {Cell}

I think that is obvious enough that the code is "exporting" 'Cell'. I couldn't tell you why though.

My second criticism is that it seems comments are all too often of the "what" variety. Simply translating the code to english. That's not really very helpful. Once someone has some grasp of the programming language being used, the "what" is right there in the programming language. No need to restate it in another language.

--http://news.ycombinator.com/item?id=3577379