2.6　代码中的注释

前面的代码中有许多注释，尤其是那些关键的步骤都有注释。注释在源码中是不可缺少的部分，合理的注释可以帮助开发者快速读懂程序代码的逻辑功能和业务功能，降低阅读的难度。注释应该是清晰简明的，不是越多越好，应该是合理的，把主要的功能和思路写清楚就可以，所以不要把注释写得很长，如下所示：

这就会显得冗余，其实用1行注释即可，如下所示：

这样的注释显得清爽，同时注明了代码的功能。有时注释会因为功能比较复杂而增多，此时可以考虑换行来注明注释，如前面在三角函数中提到的欧几里得范数函数就有必要使用多行注释来解释，如下所示：

上述代码解释公式就用了3行注释，这样才能解释清楚公式和参数的具体含义。而在Python中，如果是多行注释，除了可以使用多个“#”，还可以使用“"""”或“'''”，如下所示：

这里的多行注释使用的是“"""”或“'''”，这样可以避免每行都使用“#”。