api - 你认为好的 API 文档是什么？

Question

关闭。这个问题是opinion-based .它目前不接受答案。












想改进这个问题？更新问题，以便 editing this post 提供事实和引用来回答它.

4年前关闭。




Improve this question




一般来说，我一直很喜欢有关 Java API 的文档，但我知道有些人认为它们缺乏。所以我想知道，你认为什么是 API 文档的好例子？

请在任何答案中包含链接或实际示例。我希望有我(当然还有其他人)可以用来改进我们自己的文档的引用资料。

Answer 1

海事组织 示例 是最好的文档。