持续创作,加速成长!这是我参与「掘金日新计划 · 10 月更文挑战」的第3天,点击查看活动详情
什么是注释?
注释是给你看的,而不是让计算机运行的程序。注释是程序文档的一部分,但是运行时会忽略掉它们。
第一种——#
单行注释
在程序(或者其他任何东西)前面加一个“#“即可把它变成注释
#print(123)
这虽然是一个print函数,但是程序并不会运行它,因为它的前面加了“#”,解释器会自动忽略它们。
行末注释
print(123)#这是一个输出123的程序
注:在“#”后的程序皆会被理解为注释(本行)
多行注释
#123
#234
#234444
在任何一行程序前加上“#”都会变为注释(下面会介绍更简单的方法)
"""
这是一个字符串,但是毫无作用,所以也可以看做一个注释(尽管严格意义上来讲并不是)
"""11
11
11
11
1"""
注:他是可以跨行的
不加注释的后果
注释是非常重要的,大多数程序员都是费了一番周折才领悟到这一点。他们回头看几年前、几个月前或者是几个星期前,甚至只是昨天才写的程序时,可能完全看不明白,这往往因为他们没有加入足够的注释来解释程序是如何工作的。此时他们就会深深体会到注释的重要性。虽然你写程序的时候很清楚,但你不能保证下次看还依旧清楚。
注释要求(风格)
注释没有要求,没有任何要求。不过建议你尽可能增加注释。现在看来,注释越多越好。宁可过于谨慎注释过多,也比注释过少要好。积累更多的编程经验后,你就会慢慢了解加多少注释以及加哪种注释最适合了。