注释
所有程序员都努力使他们的代码易于理解,但有时额外的解释是必要的。在这种情况下,程序员会在源代码中留下注释,编译器会忽略这些注释,但阅读源代码的人可能会发现它们有用。
这里是一个简单的注释:
// 你好,世界
在 X 语言中,注释的规范风格是使用两个斜杠开始注释,注释会持续到行尾。对于跨多行的注释,你需要在每一行都包含 //,如下所示:
// 所以我们在这里做一些复杂的事情,长到需要
// 多行注释来完成。希望这个注释能
// 解释发生了什么。
注释也可以放在包含代码的行的末尾:
function main() {
let lucky_number = 7 // 今天是我的幸运日
}
但是你不会经常看到这种格式,而是会看到注释单独一行,位于它所注释的代码上方:
function main() {
// 今天是我的幸运日
let lucky_number = 7
}
文档注释
X 语言还支持文档注释,这些注释会编译成 HTML 文档。文档注释使用三个斜杠 /// 而不是两个,并支持 Markdown 注解:
/// 将给定的数字加一
///
/// # 示例
///
/// ```
/// let five = 5
/// assert_eq!(6, add_one(5))
/// ```
function add_one(x: integer) -> integer {
x + 1
}
我们将在后面关于标准库的章节中更详细地讨论文档注释。
注释的最佳实践
关于注释,有几点需要记住:
-
好的注释解释为什么,而不是什么 - 代码本身应该解释它在做什么。注释应该解释为什么要以某种方式做某事。
-
保持注释最新 - 过时的注释比没有注释更糟糕!当你更改代码时,请务必更新相关注释。
-
使用清晰的语言 - 注释是写给人看的,所以确保它们清晰易懂。
-
不要过度注释 - 如果代码足够清晰,就不需要注释。
总结
注释是代码库中很有价值的一部分。X 语言提供了简单的 // 语法用于单行注释,以及 /// 用于文档注释。明智地使用它们来解释为什么,而不是什么。
现在,让我们谈谈控制流!