ICode9

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

生成JavaDoc文档

2021-09-15 11:59:03  阅读:209  来源: 互联网

标签:en UTF JavaDoc 生成 文档 英语


生成JavaDoc文档

方式一:使用命令行生成JavaDoc

  1. 在资源管理器中打开想要生成的JavaDoc文档的.java文件目录

  2. 在地址栏起始位置输入cmd,回车请添加图片描述

  3. 输入命令:javadoc -encoding UTF-8 -charset UTF-8 Doc.java,回车
    请添加图片描述
    -encoding UTF-8 表示你的源代码(含有符合 JavaDoc 标准的注释)是基于 UTF-8 编码的,以免处理过程中出现中文等非英语字符乱码

    -charset UTF-8 表示在处理并生成 JavaDoc 超文本时使用的字符集也是以 UTF-8 为编码,目前所有浏览器都支持 UTF-8,这样最具有通用性,支持中文非常好

  4. 之后就可以看到生成后的JavaDoc文档
    请添加图片描述

  5. 其中index.html即为生成的API文档,可在浏览器中打开
    请添加图片描述



方式二:使用IDEA生成JavaDoc:

  1. IDEA选择Tools->Generate JavaDoc请添加图片描述

  2. 选择生成JavaDoc
    请添加图片描述
    第一步:选择生成JavaDoc文档的范围,我只对一个源文件生成Doc,所以选择文件。
    第二步:输出目录最好新建一个文件夹,比较有条理和整洁
    第三步:区域设置,决定文档的语言,简体中文就是zh_CN、繁体(台湾)zh_tw、繁体(香港)zh-hk、英语(香港)en-hk、英语(美国)en-us、英语(英国)en-gb、英语(全球)en-ww
    第四步:其他命令行参数:如果区域设置为中国,参数一般为-encoding UTF-8 -charset UTF-8
    第五步:设置完成后点击确定即可生成Doc文档

  3. IDEA会自动打开生成的API文档
    请添加图片描述

  4. 查看JavaDoc文档
    打开输出目录,就可看到成功生成,打开 index.html 便能看生成的文档。
    请添加图片描述

标签:en,UTF,JavaDoc,生成,文档,英语
来源: https://blog.csdn.net/a1976728010/article/details/120305556

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

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

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

ICode9版权所有