首页 » 与孩子一起学编程 » 与孩子一起学编程全文在线阅读

《与孩子一起学编程》9.5 注释风格

关灯直达底部

现在你已经知道了如何加注释。但是应该向注释里放什么内容呢?因为它们并不影响程序如何运行,我们说注释只是一个“风格”问题。这说明,可以在注释中放你想放的任何东西(也可以根本不使用注释)。不过这并不表示注释不重要。大多数程序员都是费了一番周折才领悟到这一点。他们回头看几年前、几个月前或者是几个星期前,甚至只是昨天才写的程序时,可能完全看不明白,这往往因为他们没有加入足够的注释来解释程序是如何工作的。此时他们就会深深体会到注释的重要性!尽管写程序时很明白,但是等以后再看程序时,很 可能对原先的想法一头雾水。

至于应该在注释中放什么内容并没有严格的规定,不过建议你尽可能增加注释。现在看来,注释越多越好。宁可过于谨慎注释过多,也比注释过少要好。积累更多的编程经验后,你就会慢慢了解加多少注释以及加哪种注释最适合了。

本书中的注释

在你手上的这本书中,你可能看不到代码清单中有多少注释。这是因为这本书使用了“注解”,也就是代码旁边的说明。不过如果查看 /examples 文件夹中或者网站上的代码清单,你会看到所有代码中都有注释。