如何创建一个Java项目文档?
- 内容介绍
- 文章标签
- 相关推荐
本文共计889个文字,预计阅读时间需要4分钟。
如何创建一个Java文档+用户手册,一个程序让他人易于理解,几千行程序也就不那么复杂了。在更多的时候,我们并不需要让别人知道我们的程序是如何写的,只需要告诉他们如何使用即可。
如何生成一个java文档1. 什么是api文档?众所周知,一个程序给别人看可能可以看懂,几万行程序就不一定了。在更多的时候,我们并不需要让别人知道我们的程序是怎么写的,只需要告诉他们怎么用的。那么,api文档就发挥了它的作用。
顾名思义,文档是给人看的,那么api文档就是告诉别人我的程序要怎么用。一个最典型的例子就是JDK8的帮助文档,如图:JDK8文档链接)
一看:一目了然,想找什么都有,极大地方便了我们这种使用JDK的人。
本文共计889个文字,预计阅读时间需要4分钟。
如何创建一个Java文档+用户手册,一个程序让他人易于理解,几千行程序也就不那么复杂了。在更多的时候,我们并不需要让别人知道我们的程序是如何写的,只需要告诉他们如何使用即可。
如何生成一个java文档1. 什么是api文档?众所周知,一个程序给别人看可能可以看懂,几万行程序就不一定了。在更多的时候,我们并不需要让别人知道我们的程序是怎么写的,只需要告诉他们怎么用的。那么,api文档就发挥了它的作用。
顾名思义,文档是给人看的,那么api文档就是告诉别人我的程序要怎么用。一个最典型的例子就是JDK8的帮助文档,如图:JDK8文档链接)
一看:一目了然,想找什么都有,极大地方便了我们这种使用JDK的人。

