javaDoc命令
目录1. 文档注释2.javaDoc命令1. 文档注释包括类的文档注释、方法的文档注释。package com.wy.www; //类文档注释 /** * author wy //作者 * vertion 1.0 //版本号 * since 1.17 //需要的最低jdk版本 */ public class Doc { //方法文档注释 /** * * author wy * param a //参数 * param b * return //返回值 * throws Exception //异常抛出情况 */ public int test(int a,int b) throws Exception{ return ab; } }2.javaDoc命令javaDoc命令能生成自己的API文档。1.使用命令行生成doc文档1找到创建的Doc类的目录在文件资源管理器搜索栏输入cmd进入命令行窗口输入javadoc -encoding UTF-8 -charset UTF-8Doc.java替换为自己的类名D:\IDEA\javaSE\javaSE\Basic grammar\src\com\wy\wwwjavadoc -encoding UTF-8 -charset UTF-8 Doc.java 正在加载源文件Doc.java... 正在构造 Javadoc 信息... 标准 Doclet 版本 11.0.16.1 正在构建所有程序包和类的树... Doc.java:6: 错误: 未知标记: vertion * vertion 1.0 //版本号 ^ 正在生成.\com\wy\www\Doc.html... Doc.java:16: 警告: param 没有说明 * param b ^ 正在生成.\com\wy\www\package-summary.html... 正在生成.\com\wy\www\package-tree.html... 正在生成.\constant-values.html... 正在构建所有程序包和类的索引... 正在生成.\overview-tree.html... 正在生成.\index-all.html... 正在构建所有类的索引... 正在生成.\allclasses-index.html... 正在生成.\allpackages-index.html... 正在生成.\deprecated-list.html... 正在构建所有类的索引... 正在生成.\allclasses.html... 正在生成.\allclasses.html... 正在生成.\index.html... 正在生成.\help-doc.html... 1 个错误 1 个警告2在Doc.java同目录下找到并点击生成的index.html文件里面就是生成的类的API文档。2.使用IDEA生成doc文档1.在菜单栏找到工具点击生成javadoc.2.选择javadoc的作用域3.自定义输出目录4.填写区域设置中国为zh_CN。填写命令行参数 -encoding UTF-8 -charset UTF-8防止有乱码。5.点击生成即可在设置的输出目录下有index.html文件。
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2409954.html
如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!