Notes

Target

Use the language you are familiar with to annotate some codes in the program to enhance the readability of the program

#Starting with , #everything on the right is treated as explanatory text, not the actual program to be executed, and only serves as an auxiliary description
The sample code is as follows:

# 这是第一个单行注释
print("hello python")

In order to ensure the readability of the code, #it is recommended to add a space first, and then write the corresponding description text.

During program development, it is also #possible to add descriptive text after (beside) the code
However, it should be noted that in order to ensure the readability of the code, there must be at least two spaces between the comment and the code
The sample code is as follows:

print("hello python")  # 输出 `hello python`

If you want to write a lot of comment information, one line cannot be displayed , you can use multi-line comments
To use a multi-line comment in a Python program, use a pair of three consecutive quotes (both single and double quotes)
The sample code is as follows:

"""
这是一个多行注释

在多行注释之间，可以写很多很多的内容……
""" 
print("hello python")

Comments are not as many as possible . For clear code, there is no need to add comments
For complex operations , several lines of comments should be written before the operation begins
Comments should be added at the end of the line for code that is not self -explanatory (for readability, comments should be at least 2 spaces away from the code)
Never describe the code, assume the person reading the code knows more Python than you, he just doesn't know what your code does

In some formal development teams, there is usually a practice of code review, that is, a team reads each other's code

PythonOfficially provides a series of PEP (Python Enhancement Proposals) documents
The 8th document specifically gives suggestions for the code format of Python , commonly known as PEP 8
Document address: https://www.python.org/dev/peps/pep-0008/
Google has corresponding Chinese documentation: http://zh-google-styleguide.readthedocs.io/en/latest/google-python-styleguide/python_style_rules/

Programmers of any language, writing code that conforms to the specification is the first step in starting a programming career