Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Peixin Li #9

Open
Irislpx opened this issue Nov 13, 2017 · 0 comments
Open

Peixin Li #9

Irislpx opened this issue Nov 13, 2017 · 0 comments

Comments

@Irislpx
Copy link

Irislpx commented Nov 13, 2017

Code Review:

  • Style Standards

Code structure looks good with stander indent and signature. But for the overall folder structure, it is easy to make people confused when reviewer is not familiar with the project contents and goals. I know there are three parts of code, but when I enter the folder there has no README file to explain each code's function.So I think you can add more reasonable explanation to describe your code.

  • Comments

Each code has some comments to let code easier to understand. However, Some arguments should be
commented either. Some comments are bad and unnecessary. Direct transliterations of code into English, for example, do nothing to improve understanding, because you should assume that your reader at least knows Python.

  • Avoid Magic Numbers

When using numbers, you can make it as a CONSTANT, which is more convenient for the further modification.

  • Use Good Names

Good method and variable names are long and self-descriptive. Comments can often be avoided entirely by making the code itself more readable, with better names that describe the methods and variables.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant