Java Doc生成文档-学习随笔

Java Doc生成文档

  1. IDEA生成作者和版本

  2. 包目录下启动Dos---在目录前加cmd+空格

    该页面点击Explorer直接会跳转到目录页面。

  3. 在Dos输入javados -encoding -UTF8 -charset -UTF8 Dos.java,回车

    • javados---生成文档

    • --encoding -UTF8 -charset -UTF8---为了多现实中文，不出现乱码

    • Dos.java---指向IDEA的文件名，Dos.java就是我程序包的名字。

      • 目录下生成很多文件

  • 打开index可看到类，构造器等内容

本次是通过命令行。

作业：学会查找使用IDEA生产JavaDoc文档！ 面向百度编程！

IDEA如何配置后生成javadoc文档

  1. one

  2. two

    注释：

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

    • 文档输出路径

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

    • 传入JavaDoc的参数，设置语言和编码集:-encoding UTF-8 -charset UTF-8 "test"

      -encoding是java代码编码，-charset是对生成文档所用的编码。-windowtitle就是对应html的<span class="md-plain">标签</span></span></span></p> <p class="md-end-block md-p"><span class="md-plain">two</span></p> </li> </ul> </li> <li class="md-list-item"> <p class="md-end-block md-p"><span class="md-plain">结果</span></p> <p class="md-end-block md-p"> </p> </li> </ol> </div> <!--conend--> <div class="p-2"></div> <div class="arcinfo my-3 fs-7 text-center"> </div> <div class="p-2"></div> </div> <div class="p-2"></div> <!--xg--> <div class="lbox p-4 shadow-sm rounded-3"> <div class="boxtitle"><h2 class="fs-4">相关</h2></div> <hr> <!----> <!----> </div> <!--xgend--> </div> <div class="col-lg-3 col-12 p-0 ps-lg-2"> <!--box--> <!--boxend--> <!--<div class="p-2"></div>--> <!--box--> <div class="lbox p-4 shadow-sm rounded-3"> <div class="boxtitle pb-2"><h2 class="fs-4"><a href="#">标签</a></h2></div> <div class="clearfix"></div> <ul class="m-0 p-0 fs-7 r-tag"> </ul> <div class="clearfix"></div> </div> <!--box end--> </div> </div> </div> </main> <div class="p-2"></div> <footer> <div class="container-fluid p-0 bg-black"> <div class="container p-0 fs-8"> <p class="text-center m-0 py-2 text-white-50">一品网 <a class="text-white-50" href="https://beian.miit.gov.cn/" target="_blank">冀ICP备14022925号-6</a></p> </div> </div> <script> var _hmt = _hmt || []; (function() { var hm = document.createElement("script"); hm.src = "https://hm.baidu.com/hm.js?6e3dd49b5f14d985cc4c6bdb9248f52b"; var s = document.getElementsByTagName("script")[0]; s.parentNode.insertBefore(hm, s); })(); </script> </footer> <script src="/skin/bootstrap.bundle.js"></script> </body> </html>