大家在工作中或者在学习中,对于一些复杂代码往往需要借助注释才能更快地理解,同样的,我们在自己写代码时也要养成写适当注释的习惯,以Python为例,那一般什么时候写注释,如何写注释呢?
注释的常见形式
(1)使用块或者行注释,对于那些复杂的操作,算法,以及可能一眼没法马上理解的代码技巧,可以考虑在代码之后添加注释。此时,可以考虑在代码后加上几个空格隔开注释,方便阅读,同时要注意注释一般是对难以理解的逻辑进行解释,对于显而易见,以及代码本身,最好不要再在注释中重复;
(2)可访问的函数和方法添加注释。一般在定义函数的语句之后,用三引号添加注释,这里注释的内容一般为函数的输出参数,参数格式,输出参数,输出参数格式,函数实现的功能等。对于一个调用函数的使用人员而言,这三点信息足矣;
(3)文件头注释。还有一种文件注释是在文件的开头,即对整份代码进行全局的介绍,此时可以考虑加入作者的信息,或者代码的版本更新信息,以及代码文件主要负责的功能,多见于模块文件(.py)的开头。