2.5 注释

注释

在Python语言中,注释是任何存在于#号右侧的文字,其主要用于说明有关程序的一切有用的信息。例如:

print('hello world')    #注意到 print 是一个函数

或者:

# 注意到 print 是一个函数 
print('hello world') 

应该在程序中尽可能多地使用有用的注释,它们将发挥以下重要的作用。

• 解释假设。

• 说明重要的决定。

• 解释重要的细节。

• 说明想要解决的问题。

• 说明想要在程序中克服的问题。

有一句非常有用的话叫作:代码会告诉你怎么做,注释会告诉你为何如此

注释在程序还有一个非常有用的作用,就是保留那些不需要执行的代码内容。对于一些暂时不需要执行的代码,可以先不删除它们,而只需要在它们前方加上#即可,只有确信永远都不需要这些代码时,才使用删除按钮将它们从代码中删除。