开发者社区> 异步社区> 正文

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

简介:
+关注继续查看

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

1.7 为代码编写注释

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

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

02c08d4a65130ed8a69d086f8a9f3a12ceb81538

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

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

f90d3ffda8ed3f3a1e3bf3d28da0b2d76abdb75f

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

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

67e1b536d2617d9794d9ba2a5f781958c41d03e4

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

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
《阿里巴巴Java Spring Boot 2.0开发实战课程》课程视频和例子代码下载
《阿里巴巴Java Spring Boot 2.0开发实战课程》系列免费课程 视频 ,例子代码
3478 0
html实体编码遇上js代码
在js中单、双引号引起来的是字符串,如果我们要在字符串中使用单、双引号,需要反斜杠进行转义。而如果字符串出现在html标签中,我们需要做转义处理。
2626 0
一气呵成编完代码的感觉对不对
  看一位大一学生的博文,他总结了他的项目的完成过程。   昨天早上在没有电脑的时候看了一下这个项目,因为不能直接输代码所以我在脑海里面构思了一下这个项目应该有的结构。正因如此,我一气呵成的输完了代码,即使有几个当时脑海中没意识到的错误,但是大思路有了编起来就很快。如果是一边输代码一边想的话,我以前经常是遇到问题就烦躁,导致一个程序耗时过长,自己也比较累,以后我拿到问题都要这样做,省时省力。
1056 0
Tidb单机版安装实战
cd /usr/local/ wget http://download.pingcap.org/tidb-latest-linux-amd64.tar.gz tar -xzf tidb-latest-linux-amd64.
3353 0
设计模式之动态代理模式实战
昨天分享了静态代理的概念及存在的缺点,所以今天讲的动态代理模式十分重要。动态代理在我们工作当中应用相当广泛,如Srping AOP就是动态代理的在开源框架的比较出名的应用。
835 0
+关注
异步社区
异步社区(www.epubit.com)是人民邮电出版社旗下IT专业图书旗舰社区,也是国内领先的IT专业图书社区,致力于优质学习内容的出版和分享,实现了纸书电子书的同步上架,于2015年8月上线运营。公众号【异步图书】,每日赠送异步新书。
12049
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
JS零基础入门教程(上册)
立即下载
性能优化方法论
立即下载
手把手学习日志服务SLS,云启实验室实战指南
立即下载