ICode9

精准搜索请尝试: 精确搜索
首页 > 编程语言> 文章详细

包机制和JavaDoc生成

2022-01-17 16:35:13  阅读:123  来源: 互联网

标签:www UTF JavaDoc 生成 文档 import 机制 com


包机制用途及用法

更好地组织类,Java提供了包机制,用于区别类名的命名空间

一般利用公司域名倒置作为包名;列如www.baidu.com 开发的时候包名就为com.baidu.www

为了能够使用某一个包的成员,在Java程序中明确导入该包,使用import语句

类中 package位置语句必须在最上面

后面import引入的类都必须在其下面

import com.abiao.www.base.project2; //用这样的方式导入
    import com.abiao.www.base.*;//导入这个包下所有的类

JavaDoc命令的用途

javadoc命令是用来生成自己API文档的

可以在文档注释里使用的参数信息有

/**
*@author 作者名
*@version 版本号
*@since 知名需要最早使用的jdk版本
*@param 参数名
*@return 返回值情况
*@throws 异常抛出情况	
*/

不过要注意的是文档注释加在类上面就是类注释,加在方法上面就是方法注释

使用CMD导出JAVADOC的办法:

  • 在IDEA中选中该类在文件中打开

  • 进入文件夹后在地址栏输入cmd+空格

  • 进入cmd输入

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

ps:我不知道为什么我输出不了

其次是使用IDEA输出:

  • 在IDEA菜单栏中找到 Tools -Generate JavaDoc 进入下面页面

解释:

  • 1是选择是整个项目还是模块还是单个文件

  • 2是文档输出路径

  • 3是Locale 选择地区,这个决定了文档的语言,中文就是zh_CN

  • 4是传入JavaDoc的参数,一般这样写 -encoding UTF-8 -charset UTF-8

标签:www,UTF,JavaDoc,生成,文档,import,机制,com
来源: https://www.cnblogs.com/threewoood915/p/15814037.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有