文档 :
先知道 软件是由上面组成的
软件 = 数据+指令+文档
而这里的文档 就是 今天要将的文档
文档 包含 使用者文档+开发者文档
使用javadoc 开发工具即可生成一个开发者问文档。
javadoc工具的使用格式 :
打开dos控制台
javadoc -d 存放文档的路径 java的源文件(.java)
使用javadoc要注意的事项:
1.如果一个类需要使用javadoc工具生成一个软件的开发者文档,那么该类必须使用public修饰。
2。文档注释 注释的内容一般都是位于类或方法的上面的
如:
public class demo1{
/**
这里是文档注释区
*/
public static void main(String[] args) {
System.out.println(“请输入用户名与密码”); //这句话是用于输入用户名与密码的。
System.out.println(“校验用户名与密码”);
System.out.println(“展示好友列表”);
}
}
写注释的规范:
一般单行注释是位于代码的右侧,多行注释与文档注释一般是写在类或者方法的上面的
多行注释与文档注释的区别:
多行内容不能用于生成一个开发者文档,而文档的内容可以生成一个开发者文档