java说明书制作 - 黑马程序员技术交流社区

/*
java说明书的生成使用jdk中的javadoc工具
生成说明书的规则:
1,类必须用public修饰
2,类的成员只有public,protected修饰的成员才会在说明书中打印
3,public内部类也行
说明书的cmd生成：
javadoc -d my -author -version Document.java
-d my: 将生成的说明说存放在my文件夹中,如果当前目录中没有my文件夹将自动生成
-author：编写者（可有可无）
-version: 版本号（可有可无）
*/
package com;
import java.io.BufferedWriter;
/**
这是一个java说明书制作事例
@author zzh //作者
@version v1.0 //版本
*/
public class Document//制作说明书类必须是最高权限public
{
/**
int型成员变量
**/
public int a;
/**
int型成员变量
**/
protected int b;
/**
int型成员变量
**/
private int c;
/**
int型成员变量
**/
public static int d;
/**
无参构造方法
*/
public Document(){}
/**
获取一个最大值
@param arr 接收一个int型数组
@return 返回一个最大值
*/
public static int Max(int[] arr){return 0;}
/**
获取一个最大值
@param arr 接收一个字符型数组
return 返回一个最大值
*/
protected static int Max(char[] arr){return 0;}
/**
显示功能
@param a 接收一个int型数
@param b 接收一个int型数
*/
public static void show(int a,int b){}
/**
显示功能
*/
private void show(){}
/**
显示功能
*/
public void show1(){}
/**
内部类
**/
public class inner
{
}
}
/**
这是一个java说明书制作事例
*/
class Document1 //在说明书中不会显示
{
/**
无参构造函数
*/
public Document1(){}
protected static int Max(char[] arr){return 0;}
/**
显示功能
@param a 接收一个int型数
@param b 接收一个int型数
*/
}

复制代码