评论

一旦你的程序变长了,逻辑也变得越来越复杂,这就是 very 放置的好主意 有意义的 代码中的注释。这使得将来您和您的合作者或主管更容易真正理解为什么您的实现是这样的。

在一开始,您的注释可以用来概述注释后面的代码块实际正在做什么。一旦您对python更加熟悉,注释的内容应该从 what 代码是用来做的 why 它正在做。

实际编写注释时,在前面加上 # 性格。所以如果你写

# In the following example you should only see
# ``Now you see me.`` in the terminal.

print('Now you see me.')
# print("Now you don't.")
print('Are you still seeing me?')  # Inline comments are nice as well!

放到一个文件中并执行它,您应该只看到

Now you see me.
Are you still seeing me?

总结

  • 您可以通过预先准备来使用注释 #

  • 评论有助于解释为什么你做了一些你做的事情

练习

  1. 如果在将来遇到一些更复杂的代码块,请对它们进行注释。诚然,这不是一个直接的练习,而是一个真诚的请求。

  2. 真的,为他人和你未来的自己评论你的代码。你会忘记为什么你用你的方式来编码。还不是真正的运动。