You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
Code Review:
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.
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.
When using numbers, you can make it as a CONSTANT, which is more convenient for the further modification.
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.
The text was updated successfully, but these errors were encountered: