java基础-说明书的制作

2016.7.10      学习内容  ：  

                                         如何写一个说明书

                                         工具类配合说明书的使用

                                         如何使用帮助文档 

一 如何写一个说明书 ？ 

                          1 . 写一个工具类 

                          2. 对这个类加入文档注释 

                          3. 用工具解析文档注释  javadoc工具

                          4. 格式 ：javadoc -d 目录 - author -version ArrayTool.java

                                 　　目录 ： 可以写一个文件夹的目录 

         制作帮助文档出错 ：

 

                        找不到可以文档化的公共或受保护的类 ：告诉我们类的权限不够

代码体现 ：

 

二 工具类配合说明书的使用     文件夹（doc文档 + 工具类class文件+ 你的java文件）

                                             查看方法是否是静态，参数类型，直接调用即可

 代码体现 ：          

三    如何使用帮助文档 

                               步骤 ：

                                       打开- 显示- 索引 -看到输入框 - 以Scanner为例  

                                         1. 看包 ： 

                                             java.lang 包下的类不需要导入，其他的全部需要导入 

             

                                            导入 ： import  java.util.Scanner;

 

                                        2. 在简单的看看类的解释和说明（着重看例子！！！）

                                         

 

 

 

                                       3. 从以下哪个类的版本开始使用 （也很重要）

 

                                       4.看类的结构

                                                 成员变量 ： 字段摘要  

                                                 成员方法 ： 方法摘要

                                                 构造方法 ： 构造方法摘要

 

                                       5.学习构造方法  ： 

                                                              A ：  有构造方法   ： 创建对象 

                                                              B ：  无构造方法   ：成员可能都是静态的，用类名调用即可

 

                                        6.  看成员方法 ： 

                                                             看左边 ：    

                                                                   是否静态 ： 可以通过类名调用 

                                                                   返回值类型 ：人家返回什么，你就用什么接收

                                                             看右边 ：

                                                                   看方法名：方法名称不要写错

                                                                    参数列表 ： 要几个，给几个