《Arduino实战》——1.7 为代码编写注释

本节书摘来自异步社区《Arduino实战》一书中的第1章，第1.7节，作者 【美】Martin Evans , Joshua Noble , Jordan Hochenbaum ，译者 况琪，更多章节内容可以访问云栖社区“异步社区”公众号查看。

1.7 为代码编写注释

你刚刚写了一段引以为豪的绝妙的代码。设想一下，在6个月之后，别人在浏览你过去的工作时看到了这段代码，但他们却搞不太懂这段代码在干什么或者是如何工作的。一段简单的说明在这时也许会派上大用场。在这种情况下，为你的代码编写注释就非常有必要了。

为程序添加注释有两种方式：单行注释和块注释。单行注释的方法是在行首添加一个双斜线（//）。这就是在告诉编译器这只是一段注释，可以将它忽略。当你想将一个代码块作为注释时，将这段代码以/开头，以/结尾即可。下面就演示了这两种方法：

你应该在哪里添加注释呢？每个程序的开头都应该有一个块注释，在其中说明这个程序起什么作用，谁在什么时间写了这些程序以及版本号等等。下面的代码清单就给出了一个代码头的示例。

代码清单1-4 代码头示例

遍布代码中的单行注释能够让你快速地了解每段代码都起什么作用。你并不需要对每一段代码都写注释，只要添加那些你认为在日后可能会帮自己和他人理解代码的注释就够了。但多写点注释总比一点都不写要好。下列代码清单展示了一些典型的代码注释。

代码清单1-5代码注释示例

我们在这节介绍了代码编辑器，了解了一个Arduino如何由setup和loop函数构成，最后探讨了为代码编写注释的必要性。