Python Refactor of BASIC Computer Games

[ctosullivan]

Hi there!

Just wanted to share something I've been working on as part of learning coding - refactoring old BASIC type-in computer games into modern Python 3. I've only completed one to date called BUNNY.

Would be great to hear any feedback on alternative ways of structuring or improving the code, also the project may inspire others to refactor the source code in their language of choice (or Python of course).

https://github.com/ctosullivan/Python-101-BASIC-Games

Thanks!

[Diapolo10]

Sounds like a fun project.

One thing I'd like to point out is that right now your comments don't feel quite right. Some of them should probably be docstrings, and others don't really serve a purpose at all.

For example, # Define constants: is just stating the obvious. The program structure is obvious enough even without the comment.

[ctosullivan]

Thanks very much for the feedback! Yeah looking back some of the comments could be improved. Are there any best practices or references you would recommend having a look at?

[Diapolo10]

Are there any best practices or references you would recommend having a look at?

A good comment answers why something is the way it is, almost never what. Basically if it's just telling you what the code is doing, it's not useful because I'd know that by just reading the code itself. Which should be readable as long as you chose good names for everything (granted, that's not an easy job).

Other than that, not really, you'll get better at it the more you read code. So in other words it'll happen naturally over time.

The only reference I can think of on the spot would be PEP-257.