28、代码文档与测试：保障软件质量的关键

代码文档与测试：保障软件质量的关键

1. 文档编写的重要性及类型

在软件开发中，文档编写是至关重要的一环。它不仅能帮助用户更好地使用软件，也有助于开发者维护和扩展代码。以下是几种常见的文档类型及其作用：
- 包含预期异常的文档 ：每段代码都可能抛出异常，有些异常是代码预期功能的一部分。例如，当按名称查找对象却未找到时就会出现这种情况。在这种情况下，应在返回值旁边记录这些异常。明确指出会抛出哪些异常以及在何种情况下抛出，因为调用函数的代码通常会捕获这些异常。
- 代码外的文档 ：除了代码内的文档字符串，还需要在代码外部对应用程序进行文档编写。外部文档与代码内文档的不同之处在于信息的呈现方式，并且可能包含代码本身未涵盖的额外信息。其涵盖的主题广泛，能满足不同用户的需求。

2. 不同类型的外部文档

• 安装与配置文档 ：在用户使用软件之前，需要获取并使其正常运行。这就需要详细说明获取代码的方式，有时可能只需一行简单的命令，而在其他情况下，可能需要先获取版本控制软件等其他应用程序，以获取最新代码。
• 教程文档 ：许多用户在获得应用程序后，希望立即了解如何使用它。教程是引导用户了解应用程序最常用功能的好方法，还能展示应用程序的优势，吸引用户尝试使用，尤其对于库和框架来说，能让用户快速感受其对自身代码的帮助。
• 参考文档 ：当用户对应用程序有了一定了解并积累了一些使用经验后，他们的需求会发生变化。此时，他们需要提醒自己各个功能如