注释

读代码比写代码还要困难 ——Joel Spolsky

在进行项目的开发时，有的时候几个周前自己写的代码都看不懂了::tears_of_joy::
代码的表义毕竟不像自然语言那么直接，常常会遇到看不懂的情况。这个时候，良好的注释是解决问题最有效的手段。

注释（Comments）是夹杂在程序中的注解。有的时候为了实现简单的功能却不得不用篇幅很长的代码。阅读简短的注释远比阅读长代码高效。
注释就像程序实现的摘要。其目的是方便人阅读理解，而计算机会忽略注释。下面是一个示例：

# 生成斐波那契数列的第 n + 3 项 #
fibo = func(num1 -> lit.num, num2 -> lit.num, remain -> lit.int) {
	if (remain == 0) {
		return(num1 + num2)
	}
	else {
		return($func(num2, num1 + num2, remain - 1))
	}
}

这个程序的第一行就是一行注释。这行注释清楚地描述了下面代码的作用。
就这个示例而言，当看到这行注释时，可以只花费1s的时间就能了解代码的功能。但如果没有注释，即使有经验的程序员也要花上10s左右。

在真实的项目开发中，功能远比这个示例要复杂。所以良好的注释能够加快开发的效率，减少风险与错误；而糟糕的注释或没有注释通常是一种灾难。

---

Lit 的注释有两种写法（俗称单行注释和多行注释）：

1. ;; 注释 在一行代码的末尾加上连续的两个分号，从分号起直到行尾为注释。

pass ;; single-line comments

2. # 注释 # 从一个井号到第二个井号的内容为注释，支持转义。

# Document Introduction
文档说明
%)$&3!`#@...
#

将代码注释用作调试