JAVA基础 怎么写一个java程序说明

为什么要写说明书

我写好了一个JAVA程序卖给你,从源码可以看出这个程序的功能,
但是我肯定不能把源码给你看啊,
如果我把class丢给你 也不对劲,你看不懂二进制文件

所以最好的解决方案就是把class丢给你 顺便在配套送你个说明书。

怎么写一个java程序说明

java的说明书通常使用文档注释来完成

/**
第一行通常是描述信息:例子:这是一个数组工具类该类提供了排序,最值等功能。
@author 赵轩
@version V1.0
*/
public class ArraysTool{
	/**
	空参数的构造函数
	*/
	private ArraysTool(){
	}
	/**
	获取一个int数组中的最大值
	@param arr 接收一个int数组
	@return 返回一个int数组
	*/	
	public static int max(int[] arry){
	}
	public static void sort(){
	}
}

OK以上的文档注释写完了
然后进入cmd去生成工具书
需要使用bin目录下的javadoc
-d 存到哪个目录 (没有会自动建立)
-author 添加作者
-version 添加版本信息

javadoc -d help

要想把一个类生成文档 必须public

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值