如何生成一个类的帮助文档

怎么写一个类的说明书:
为什么要文档注释:当真正做公司做事的时候,分工明确,每个人可能只要提交一个class文件和一个文档注释就OK了,根本就不要提供java文件。
用文档注释:即 /******/。文档注释里面加入
@param 表示参数是什么、@return 表示返回值是什么、@author 表示作者是谁、@version 表示类的版本
用工具解析文档注释:即javadoc工具。
格式为:javadoc -d 目录(自己写) -auther -version 类名.java 


怎么从API里看一个方法:
A:看类的结构 
成员变量  就是字段摘要
构造方法  就是构造方法摘要
成员方法  方法摘要
B:怎么学习构造方法
a:有构造方法的  就创建对象
b:没有构造方法的  成员可能就都是静态的
C:看成员变量
a:左边:是否静态,如果静态,可以通过类名调用。返回值类型是什么,人家返回什么,你就给什么
b:右边:看方法名,方法名不要写错。看参数列表,人家要什么就给什么,人家要几个,就给几个。

你可能感兴趣的:(java基础)