下载掌阅APP，畅读海量书库
立即打开
文档 包含了程序代码的相关信息。文档主要分为两类： 注释和 README 文件。
所有编程语言都提供了为代码添加注释的功能。注释并不是程序的一部分，当程序运行的时候会跳过这些注释，用户也看不到注释。 注释是由程序员编写的，包含程序代码的相关信息， 可能是对某一段代码功能的解释，对代码中要增加或修改的部分的提示，或者是对其他可能阅读这段代码的程序员的提问。
在屏幕顶端添加一个倒计时时钟。
为代码添加注释可以帮你回忆每段代码的功能，这对于大型程序非常有用，因为你没办法记住每一行代码到底为什么会这样写。对于短小的程序来说，注释也很有用，因为你有可能会在过了很久之后重新读这段程序代码。
有时候，你希望重用来自其他程序的一段代码，或者是重用你自己或者其他人之前编写的代码。注释可以帮你快速找到哪段代码是可以重用的。例如，在编写游戏的时候，你可能不会从头编写一段让角色移动的代码，而是可以从其他程序中复制一段类似的代码。你可以在程序中添加注释，这样你一看就知道这段程序是干什么用的。
注释还可以帮助你调试程序，因为注释的内容不会被计算机运行。你可以将一段代码 注释掉 ，这样就可以在不删除代码的情况下，快速屏蔽一段代码（也许这段代码里有bug）。
将一段代码转换成注释，这段代码将不会被计算机运行。
在调试程序时，你还可以添加一些测试代码来帮助调试，并在测试完成之后将这些代码注释掉。
注释也可以用来在你编写代码的时候做一些记录。
例如，你可以写一些像这样的备忘文字：
#BUG或者#FIXME
——这里有一个已知的错误，稍后需要修复。
#TODO
——关于哪些代码仍然需要编写，要稍后返回来写的注释。
README （为了引起注意，通常把所有字母大写） 文件记录了一个程序的相关信息， 包括程序里包含哪些文件、如何安装和使用、开发人员名单及已知的bug，等等。
README文件是为用户写的，也是为其他程序员写的。通常来说，一个程序只有一个README文件，一般是一个 纯文本文件 。
只包含文字和标点符号，不包含任何格式信息（如粗体、斜体、缩进、段落间距等）的文本文件。
尽管README文件也可以包含用户所需要的一些信息，但通常会有另外一份用户指南来帮助用户了解程序的使用方法。一般来说，只有像微软的Word、Excel这样的大型程序才会附带用户指南。
1. 你可以编写哪两种文档来帮助其他人了解你的程序？
2. 哪种类型的文档可以帮你记住某段特定代码的功能？
3. 为什么把一段代码注释掉可以帮助调试？
4. 为什么说注释对你和其他程序员有用？
5. 以下哪些是使用文档的原因？（选出所有正确的选项）
A. 让你更容易找到某段代码
B. 更容易进行协作
C. 你可以在写程序时留下记录
D. 帮你找到bug
E. 展示开发者名单
F. 说明程序的使用方法
6. 如果想在代码中记录一段备忘文字，表示稍后需要修复一个错误，你可以添加这样的注释：________。
7. 你会使用哪种文档来帮助用户安装你的程序——README文件，还是代码中的注释？
8. 什么是用户指南？
答案见下面
1 .注释和README文件。
2 .注释。
3 .因为注释的内容不会被计算机运行，将一段代码注释掉就可以在不删除代码的情况下，快速屏蔽一小段代码。
4 .如果你和其他程序员一起合作来完成一个项目，其他程序员要理解一段代码的功能，读代码中的注释比直接读代码要更容易一些。
5 . A ， B ， C ， D ， E ， F 。（所有的选项都正确）
6 .#BUG或#FIXME。
7 .README文件。
8 .用户指南是一份可以帮助用户了解程序功能的文档。