JAVA基础02——JAVA的包机制和JAVADoc

1、JAVA的包机制

包的作用:
1 、把功能相似或相关的类或接口组织在同一个包中,方便类的查找和使用。
2 、如同文件夹一样,包也采用了树形目录的存储方式。同一个包中的类名字是不同的,不同的包中的类的名字是可以相同的,当同时调用两个不同包中相同类名的类时,应该加上包名加以区别。因此,包可以避免名字冲突。
3 、包也限定了访问权限,拥有包访问权限的类才能访问某个包中的类。
Java 使用包( package )这种机制是为了防止命名冲突,访问控制,提供搜索和定位类( class )、接 口、枚举(enumerations )和注释( annotation )等。
一般利用公司域名倒置作为报名;
例子: www.baidu.com  包名: com.baidu.www

2、JAVADoc

JavaDoc 是一种将注释生成 HTML 文档的技术,生成的 HTML 文档类似于 Java API ,易读且清晰明了。
在简略介绍 JavaDoc 写法之后,再看一下在 Intellij Idea 中如何将代码中的注释生成 HTML 文档。
javadoc Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API 帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过 Javadoc就可以同时形成程序的开发文档了。 javadoc 命令是用来生成自己 API 文档的,使用方式:使用
命令行在目标文件所在目录输入 javadoc + 文件名 .java
- encoding UTF - - charset UTF - 8 //可以解决中文乱码问题
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
您好!感谢您的提问。根据您的问题,我理解您想要将一个Java项目的Javadoc转移到另一个Java项目的Javadoc中。如果我的理解有误,请让我知道。 要将一个Java项目的Javadoc转移到另一个Java项目的Javadoc中,您可以按照以下步骤操作: 1. 在源代码中为您想要转移的类和方法添加Javadoc注释。您可以使用以下示例注释格式: /** * 这是一个示例方法。 * @param param1 参数1 * @param param2 参数2 * @return 返回值 */ 2. 使用JavaDoc工具生成Javadoc文档。您可以使用以下命令生成Javadoc文档: javadoc -d [输出目录] [需要生成文档的Java文件] 例如: javadoc -d /home/user/myproject/doc -sourcepath /home/user/myproject/src com.example.myproject 这将生成一个名为index.html的Javadoc文档文件,可以在浏览器中查看。 3. 将生成的Javadoc文档复制到您想要转移的Java项目中。您可以将生成的Javadoc文档文件夹复制到您想要转移的Java项目的根目录下。 4. 在目标Java项目中使用Javadoc注释中的@see标签引用源Java项目的Javadoc文档。例如: /** * 这是一个示例方法。 * @param param1 参数1 * @param param2 参数2 * @return 返回值 * @see com.example.myproject.ExampleClass#exampleMethod */ 这将在Javadoc文档中为该方法添加一个“参见”链接,该链接指向源Java项目中的ExampleClass类和exampleMethod()方法。 希望这些步骤能帮助您将一个Java项目的Javadoc转移到另一个Java项目的Javadoc中。如果您有任何其他问题,请随时问我。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

上兵伐眸

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值