Java SE_包机制、JavaDoc生成文档

package com.landray.sty;

//导入包
import java.util.Date;
//导入包
import com.landray.sty.demo;
//*通配符,会导入这个包下所有类
import com.landray.sty.*;

public class Demo10 {

	public static void main(String[] args) {
		/****************** 包机制开始 ************************/
		// 推荐可以查看《阿里巴巴开发手册》
		// 为了更好地组织类,Java提供了包机制,用于区别类名的命名空间。(包的本质其实就是一个文件夹)
		// 包语句的语法格式为:
		// package pkg1[. pkg2[. pkg3...]];
		// 一般利用公司域名倒置作为包名;(命名规范)
		// 例如:公司(www.baidu.com)
		// 包命名(com.baidu.www)、(com.baidu.baike)、(com.baidu.wenku)、(com.wang.xxx)
		// 为了能够使用某一个包的成员,我们需要在Java程序中明确导入该包。使用"import”语句可完成此功能
		// import package1[.package2...].(classname|*);
		// import java.util.Date;必须放在package下面
		// import com.landray.sty.demo;
		// import com.landray.sty.*;
		/****************** 包机制结束 ************************/
	}

}

JavaDoc生成文档:


package com.landray.sty;

/**
 * @author wangxf
 * @date 2021年4月1日
 * @version 1.0
 * @since 1.8
 */
public class Doc {
	String name;

	/**
	 * @author wangxf
	 * @date 2021年4月1日
	 * @param name
	 * @throws Exception
	 */
	public String test(String name) throws Exception {
		return name;
	}

	/****************** JavaDoc生成文档 ************************/
	// javadoc命令是用来生成自己API文档的
	// 参数信息:
	// @author 作者名
	// @version 版本号
	// @since 指明需要最早使用的jdk版本
	// @param 参数名
	// @return 返回值情况
	// @throws 异常抛出情况
	// 例:API文档可以搜索《JDK帮助文档》
}

在开发工具中进入当前类的所在的磁盘路径,在地址栏中出入“cmd”,进入dos窗口,输入命令“javadoc -encoding UTF-8 -charset UTF-8 Doc.java”,就会在对应的文件夹中生成当前文件(类)的API文档说明。(因为我这里的javadoc的命令无法识别,所以不能演示最终效果)
在这里插入图片描述
在这里插入图片描述

在这里插入图片描述

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值