标签：注释 Java name JavaDoc 生成 语法 文档 com
Java基础语法4：包机制、JavaDoc
包机制
- 为了更好的组织类，Java提供了包机制，用于区别类名的命名空间。
- 包的本质就是文件夹
- 包语句的语法格式为：
package pkg1[.pkg2[.pkg3...]];
-
一般利用公司域名倒置作为包名；
- 例如www.baidu.com的包为com.baidu.www
-
为了能够使用某一包的成员，我们需要在java程序中明确导入该包。使用"import"语句可完成此功能
import package1[.package2...].(classname|*);
- import package1[.package2...].classname|*
- 其中*为导入这个包下所有的类，通配符
- 推荐看一本书《阿里巴巴Java开发手册》
- 一定要认真看一下这本书，里面都是基础
JavaDoc
- javadoc命令是用来生成自己API文档的
- 参数信息
- @author作者名
- @version版本号
- @since指明需要最早使用的jdk版本
- @param参数名
- @return返回值情况
- throws异常抛出情况
- 创建一个简单的类：例如Doc
- 加在类上的注释为类的注释
- 在方法上的注释为类的注释
- 下面创建一个简单的文档架构
package com.song.base;
//类的注释
/**
* @author song //作者
* @version 2.0 //版本
* @since 1.8 //指明需要最早使用的jdk版本
*/
public class Doc {
//随便定义一个变量
String name;//属性
//方法的注释
/**
* @author song //作者
* @param name //参数名
* @return //返回值情况
* @throws Exception 抛出异常
*/
public String test(String name) throws Exception {
return name;//方法
}
}
- 然后使用IDEA生成Javadoc文档
使用IDEA生成文档的方法
方法一
-
右击Doc -----> 点击 Open In Explorer找到文档所在位置
-
在打开路径页面上选中路径，输入cmd+回车
- 然后打开该文档位置的doc指令
-
输入命令Javadoc -encoding UTF-8 -charset UTF-8 Doc.java回车
-
然后原文档的文件夹里会生成很多新的东西
-
主要找到index.html（主页），然后双击就会生成文档
方法二
-
（选中要生成文档的类）找到工具栏tools --> Gencrate JavaDoc…打开
-
在弹出的窗口主要进行三步
- 第一步：点击第三个：文档所在的位置
- 第二步：输入语言环境为中文：zn_CN
- 第三步：输入命令行参数: -encoding UTF-8 -charset UTF-8
-
然后点击Generate（生成）生成文档
-
最后在生成的com文件夹里找到index.html（主页），然后双击就会生成文档
标签：注释,Java,name,JavaDoc,生成,语法,文档,com 来源： https://www.cnblogs.com/sunyusong/p/16504215.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。