主要学习,api文档怎样去看,以及在项目中怎样生成api文档。
首先需要了解包。
一、包的用法:
把类都放在包中,可以解决类之间的重名问题,也便于管理类。
对于包的命名,一般采用域名倒写,便于分辨。
对于包的用法,详细看上面图片的介绍。
主要的包:
尽量查看英文的api文档。
生成自己项目的API文档
首先需要注意的是,一定需要加上/** 的注释。
按照上述图片介绍,很好的注释好代码以后,此时有一个好处就是,注释与代码是放在一起的。查询代码的时候,一目了然。
就像这样:
然后生成api文档。步骤:
鼠标右键单击项目,然后点Export,弹出一个对话框,选中java,javadoc,选中next。此时就是执行javadoc.exe commands 。选中输出文档的文件夹,然后finish,点击yes for all。
全部生成完毕,打开目标文件夹,打开index.html。就像看普通api文档一样看注释了。
二、接收键盘输入
方便电脑与用户的交互。需要学习的类Scanner。