代码注释就是为写好的代码片段添加注解。做代码注释有以下两点好处:
● 能更好地维护项目,也能让阅读者更快地读懂代码的意思。
● 在做代码调试时,如果需要让一部分代码暂时不运行,就可以使用注释的方法。
单行注释,即注释只作用于一行。在单独的行写注释内容之前,要输入“#”(井号),案例代码如下所示,代码在“Chapter-1-3.py”文件中。
在PyCharm中,进行代码注释也可以使用快捷键,选择要注释的行(单行或多行均可),然后按【Ctrl+/】组合键;如果需要取消注释,则再按一次【Ctrl+/】组合键。
除单独在一行中做注释外,也可以在代码的后面做注释,案例代码如下所示,代码在“Chapter-1-4.py”文件中。
注意:在代码后面做注释,不能使用【Ctrl+/】组合键。
如果有大段的注释文字要写,则可以使用多行注释的方法。多行注释的内容要包含在一对单引号中,6个单引号为一对。案例代码如下所示,代码在“Chapter-1-5.py”文件中。单引号中的内容不会被运行。
除使用单引号做注释外,还可以使用双引号来做注释。案例代码如下所示,代码在“Chapter-1-6.py”文件中。双引号中的内容也不会被运行。
到底是使用单引号做注释,还是使用双引号做注释,没有强制规定,完全根据用户的习惯而定。