《Arduino实战》——1.7 为代码编写注释
本节书摘来自异步社区《Arduino实战》一书中的第1章，第1.7节，作者 【美】Martin Evans , Joshua Noble , Jordan Hochenbaum ，译者 况琪，更多章节内容可以访问云栖社区“异步社区”公众号查看。
1.7 为代码编写注释
你刚刚写了一段引以为豪的绝妙的代码。设想一下，在6个月之后，别人在浏览你过去的工作时看到了这段代码，但他们却搞不太懂这段代码在干什么或者是如何工作的。一段简单的说明在这时也许会派上大用场。在这种情况下，为你的代码编写注释就非常有必要了。
为程序添加注释有两种方式：单行注释和块注释。单行注释的方法是在行首添加一个双斜线（//）。这就是在告诉编译器这只是一段注释，可以将它忽略。当你想将一个代码块作为注释时，将这段代码以/开头，以/结尾即可。下面就演示了这两种方法：
你应该在哪里添加注释呢？每个程序的开头都应该有一个块注释，在其中说明这个程序起什么作用，谁在什么时间写了这些程序以及版本号等等。下面的代码清单就给出了一个代码头的示例。
代码清单1-4 代码头示例
遍布代码中的单行注释能够让你快速地了解每段代码都起什么作用。你并不需要对每一段代码都写注释，只要添加那些你认为在日后可能会帮自己和他人理解代码的注释就够了。但多写点注释总比一点都不写要好。下列代码清单展示了一些典型的代码注释。
代码清单1-5代码注释示例
我们在这节介绍了代码编辑器，了解了一个Arduino如何由setup和loop函数构成，最后探讨了为代码编写注释的必要性。
《Arduino实战》——1.7 为代码编写注释相关推荐
- 如何为javascript代码编写注释以支持智能感知
在使用Visual Studio做开发的时候,智能感知是非常方便的.从VS2008开始,提供了对javascript的智能感知支持.例如 上述代码中,我们先用document对象的getElement ...
- cocoscreator游戏开发实战——动物餐厅——菜单代码编写（2）
首先新建一个Food脚本,然后把他挂载到Food这个预制体上,目的远程加载图片.去显示菜单德图片. 使用的api cc.assetManager.loadRemote(info['URL'],func ...
- cocoscreator游戏开发实战——动物餐厅——菜单代码编写（1）
这是项目结果图,我们这章节主要介绍怎么实现它. 首先:新建一个模块脚本,命名为config,然后在配置要求的菜单信息. name:是物品名称, id:是数据索引 URL:是物品的云存储链接 del, ...
- 【经验科普】实战分析C工程代码可能遇到的编译问题及其解决思路
文章目录 1 前言 2 回顾 2.1 主要内容 2.2 知识点回顾 3 实战分析 3.1 代码编写阶段 3.2 预编译阶段 3.2.1 No such file or directory (找不到某个 ...
- 《Java和Android开发实战详解》——2.5节良好的Java程序代码编写风格
本节书摘来自异步社区<Java和Android开发实战详解>一书中的第2章,第2.5节良好的Java程序代码编写风格,作者 陈会安,更多章节内容可以访问云栖社区"异步社区&quo ...
- 《Spark商业案例与性能调优实战100课》第18课：商业案例之NBA篮球运动员大数据分析代码实战之核心基础数据项编写
<Spark商业案例与性能调优实战100课>第18课:商业案例之NBA篮球运动员大数据分析代码实战之核心基础数据项编写
- 使用C语言编写程序一个皮球从100米高度自由落下，每次落地后反弹回原高度的一半，再落下，再反弹。求当它第10次落地时，共经过了多少米？第10次反弹多高？写出完整代码并给出解释并对代码作出注释...
使用C语言编写程序一个皮球从100米高度自由落下,每次落地后反弹回原高度的一半,再落下,再反弹.求当它第10次落地时,共经过了多少米?第10次反弹多高?写出完整代码并给出解释并对代码作出注释第10次落 ...
- c语言期中项目实战二—简易扫雷，思路分析加代码详细注释
c语言期中项目实战二-简易扫雷,思路分析+代码详细注释 游戏介绍 项目步骤 模块化编程 设置菜单 设置棋盘 打印棋盘 布置雷 排查雷 总结及总代码和详细注释 游戏介绍 扫雷这个经典游戏,直到现在仍有很 ...
- Arduino语法详解，部分带注释（学习笔记）
Arduino 的程序可以划分为三个主要部分:结构.变量(变量与常量).函数 函数部分参考官方:Arduino Reference - Arduino Reference 结构部分 一.结构 1.1 ...
最新文章
- 【jstl】jstl的基本操作
- VC2010 编译问题
- 网站内容收录除了原创性和质量其他因素也少不了
- php中什么是函数函数的意义是什么,php中arsort函数的功能起什么作用呢？
- CAS 4.1.x 单点登出（退出登录）的原理解析
- 基于Jenkins 快速搭建持续集成环境
- CentOS6系统编译部署LAMP(Linux, Apache, MySQL, PHP)环境
- science图表_Science和Nature大部分图表都出自这款绘图软件，了解一下？
- DES算法理解--附《密码编码学与网络安全（第七版）》课后练习题答案
- 中级微观经济学：Chap 9 购买和销售
- linux系统下网络吞吐量/CPU占用率/流量控制的测试
- android studio 实例代码,android studio学习之一(示例代码)
- 【实用】齐齐哈尔市公交车线路站点汇总
- 关于基线长度对双天线GNSS测姿精度的影响
- CSharp 常用函数
- python自动化办公读后感_《Python编程快速上手——让繁琐的工作自动化》读书笔记3...
- 运维(21) 制作WinPE启动U盘
- 哈哈日语 五十音图之あ段音
- 【每日新闻】2017年亚马逊研发投入排世界第一，超过华为、BAT 总和 | 数人云宣布与UMCloud合并
- c# 调用jtts_Intouch、Wonderware实现真人语音报警