Python初级教程（二）：关于注释

上次答案：略。

1.2 关于注释(comment)

这一部分大体上参考@RSGC2-18的文章。

1.2.1 注释怎么写

在Python中，注释有2种写法：

第一种 利用#字符写注释。

# this is a comment print(1000)
print(1024) # this is a comment

运行后不难发现，控制台中只有1024出现。这说明#号注释后面的内容都不会运行，而且只持续1行。

第二种 字符串。

在Python中，你可以直接在程序里“运行”字符串。但是它会直接被跳过，不返回任何内容。

"I love Python!"
print("I like Python!")

只有I like Python!被打印。

另外还有特殊的多行注释。

"""I love Python!
Python is great!
Wow! Python!
"""
print("I like python!")

一般情况下，注释不会影响代码运行，除非用某些奇特的方法。比如下面这个：

（目前你不用知道它的意思。回头你可以回来看。）

<foo.py>
​
from bar import read
# foo foo foo
​
print("Hello World!")

<bar.py>
​
with open('foo.py') as filestream:
    # ...(read line 2 and bla bla bla)
    
# ... (Use it)

上面的例子读取了python文件，这个时候注释会影响代码运行。

1.2.2 你该写什么样的注释

1. 写注释不能讲废话

建议这样：

a = 700
# we set a as 700 to bla bla bla, and 700 is the best value for ...

不建议（因为谁都看得懂，浪费时间）：

a = 700 # set variable a as 700

 

2. 写注释必须讲清楚

建议这样：

# ...
a = requests.get("/") # this is ..., to get the exact data, we use ...

不建议（没有人知道你想干什么，包括2个月后的你）：

# ...
a = requests.get("/") # *&#^@(*$&#(@*@^!$

 

3. 写注释要简短

建议这样：

a = 1
# Lorem ipsum

不建议（看的人会因此恼火！）：

a = 1
# Lorem ................
# Ipsum ................
# Dolor ................
# sit ..................
# amet .................
# ......................
​
# ...

 

4. 用英语写注释

建议这样：

a = 700
# we set a as 700 to bla bla bla, and 700 is the best value for ...

不建议（下为芬兰语。如果外国程序员来看你的代码，你们之间的唯一桥梁是英语。）：

a = 700
# Me asetamme 700-luvun bla bla bla, ja 700 on paras arvo...on

 

5. 写注释讲耐心

建议写注释。

不建议：

a = 700

或者

a = 700 # fuck! this is 700. DO YOU UNDERSTAND?

 

 

1.2.3 习题

为上篇文章中你修改过的代码添加合理的注释。