自己写Java文档一般需要有哪些内容??
发布网友
发布时间：2022-04-26 02:50
共3个回答
热心网友
时间：2022-06-20 05:55
每个非 private 方法的参数说明，像 getter/setter 这样简单的就省略掉。主要是关键方法和类的设计要有说明。另外，一些方法有内部的实现约定，也就是前提条件，这个在技术上没办法验证的或验证它会影响性能等，我们就只在文档中说明，不在代码中检查了。举个例子，java.util.ArrayList 不是一个线程安全的集合实现类，它就在文档中说明了这点，另一个就是 equals 和 hashcode 方法在你覆盖它时应该同时按相同的算法覆盖两个，只覆盖一个就不符合设计约定。再一个就是简要说明你的关键方法和类是如何设计的。
一个好的文档可以用来回答 What, Why & hoW 这三个 W。
热心网友
时间：2022-06-20 05:55
UML图。设计文档。代码、API的javadoc注释等
热心网友
时间：2022-06-20 05:56
就像你电脑系统的帮助文档一样，还有JavaDoc注释。目的呢就是怕你过了很久，忘记了当初写这个代码的思路
