20、Java 开发中的文档编写与日志记录及单元测试

Java 开发中的文档编写与日志记录及单元测试

1. 文档编写

在 Java 开发中，文档编写是一项至关重要的工作。整个 Java 库都有 Javadocs 进行描述，并且可以在浏览器中搜索。对于我们自己编写的代码，最佳实践是编写 Javadocs 注释，这意味着要详细描述程序每个部分的功能以及为什么要这样实现。同时，还可以使用 /* ... */ 和 // 符号在方法中添加额外注释或临时移除代码。

2. 日志记录

2.1 日志记录的必要性

在程序运行时，我们可能希望在控制台显示一些消息，例如捕获到异常或记录其他事件。但不建议使用 System.out.print 、 println 或 printf 来实现，因为对于基于控制台的应用程序，这些语句会与控制台用户界面一同显示；对于 GUI 或 Web 应用程序，控制台可能不可见。而且在程序投入生产后，这些消息可能会让最终用户感到困惑或不知所措。因此，使用日志记录是更好的解决方案。

2.2 Java 内置日志框架（java.util.logging）

2.2.1 框架组成

Java 内置的日志框架 java.util.logging （简称 JUL）由 Java 类框架和配置文件两部分组成。默认的配置文件 logging.properties 位于 Java 安装目录的 conf 文件夹中。我们可以使用