注释
在大多数编程语言中,注释是一个非常有用的特性。到目前为止,您在程序中编写的所有内容都是 Python 代码。随着你的程序变得越来越长和越来越复杂,你应该在你的程序中添加注释来描述你解决问题的总体方法。注释允许您在程序中用您的口语写注释。
如何编写注释
在 Python 中,井号 (#
) 表示注释。Python 解释器将忽略代码中井号后的任何内容。例如:
comment.py
# Say hello to everyone.
print("Hello Python people!")
Python 忽略第一行并执行第二行。
Hello Python people!
该编写什么样的注释
写注释的主要原因是解释你的代码应该做什么以及你是如何让它工作的。当您正在处理一个项目时,您会了解所有部分是如何组合在一起的。但是当你离开一段时间后再回到一个项目时,你可能会忘记一些细节。你总是需要研究你的代码一段时间并弄清楚段应该如何工作,但是写好的注释可以通过清楚地总结你的整体方法来节省你的时间。
如果你想成为一名专业的程序员或与其他程序员合作,你应该写有意义的注释。 今天,大多数软件都是协作编写的,无论是由一家公司的一群员工还是一群在开源项目上一起工作的人。熟练的程序员希望在代码中看到注释,因此最好现在就开始向您的程序添加描述性注释。在代码中编写清晰、简洁的注释是作为新程序员可以养成的最有益的习惯之一。
当你决定是否写注释时,问问自己在想出一个合理的方法之前是否必须考虑几种方法;如果是这样,请写下关于您的解决方案的注释。稍后删除多余的注释比返回并为稀疏注释的程序写注释要容易得多。从现在开始,我将在整本书的示例中使用注释来帮助解释代码段。