注释与整洁的程序
编写说明并组织结构，让代码保持易读
注释与整洁的程序 是 CoddyKit 上的免费 Arduino & IoT Academy 课时。 这是第 3 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Arduino & IoT Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Arduino & IoT Academy 课程共包含 4 节课。
写给人看的注释
代码被阅读的次数远多于被编写的次数。注释是您留下的说明，帮助未来的自己理解草图。📝
单行注释
输入两个斜杠后，该行剩余内容就会成为注释。开发板运行代码时会完全忽略它。
// this line is just a note
digitalWrite(13, HIGH);在行尾添加注释
您可以在同一行的有效代码后添加注释。它会解释这一步的具体作用，而不会造成任何影响。对于快速补充说明非常方便。
delay(1000); // pause for one second块注释
对于较长的说明，可以将文字放在斜杠星号和星号斜杠之间。这个代码块可以跨越多行，非常适合写描述。
/* This sketch blinks
the onboard LED. */注释不会运行
注释中的任何内容对开发板都是不可见的。它只供读者阅读，因此绝不会影响设备的行为。
解释原因，而不是解释作用
好的注释会说明某行代码为什么存在，而不只是重复它做了什么。请写下原因，因为代码本身已经展示了操作。
delay(20); // debounce noisy button缩进有助于阅读
花括号中的代码行应向内缩进几个空格。这样的缩进能显示哪些内容属于同一部分，也让逻辑更容易浏览。
void setup() {
pinMode(13, OUTPUT);
}清楚地命名
清晰的名称胜过注释。将引脚命名为ledPin，而不是只使用一个数字，可以让读者准确知道它控制的对象。
int ledPin = 13;注释掉代码来测试
在代码行前添加斜杠，就能暂时禁用该行。注释掉代码后，您可以进行测试，而不用删除以后可能还想恢复的代码。
// digitalWrite(13, LOW);避免显而易见的杂乱注释
不要为每一行代码都写说明。像“给 x 加 1”这样的注释只会增加杂乱，并没有带来价值。请把说明留给真正需要解释的部分。
整洁的草图经得起时间考验
整齐的空格、清晰的名称和有用的注释，能让草图在几个月后仍然容易修改。易读的代码才是可靠的代码。
快速检查
让我们检查一下注释的作用。
回顾：整洁的草图
您学会了使用注释、// 和斜杠星号，在花括号内缩进，以及清楚地命名。易读的草图始终易于维护。🎉
用 AI 导师学习 C++ — 免费
在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。
- 课程
- 30
- 课程
- 120
常见问题解答
「注释与整洁的程序」课时是免费的吗？
是的 — 「注释与整洁的程序」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Arduino & IoT Academy 课程的其余内容，请升级到 CoddyKit PRO。 Arduino & IoT Academy 课程共包含 4 节课。
「注释与整洁的程序」这节课中我会学到什么？
编写说明并组织结构，让代码保持易读 你通过在浏览器中直接运行的动手代码来练习 Arduino & IoT Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Arduino & IoT Academy 需要有经验吗？
无需任何先前经验。CoddyKit 上的 Arduino & IoT Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 3 节课，共 4 节。
「注释与整洁的程序」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 Arduino & IoT Academy 课中编写并运行代码吗？
能。每节 Arduino & IoT Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。