跳到主要内容

三分钟上手 JavaDoc 在线生成和托管

我没事的时候喜欢翻翻 Java 的 API ,翻翻用过的开源项目的 API 文档。不时会有惊喜,不经意会发现一些黑科技。

三分钟上手 JavaDoc 在线生成和托管-Gitee 官方博客

看项目文档,当然,你最多掌握 60\% 该项目的技能(文档非常完善的前提下)

熟读项目 API 文档 —— 恭喜你,又多了 30\% (精通程度)。

剩下的 10\% 靠的是阅读源码+天赋,谁也帮不了你。

—– 以下是广告时间 —–

码云在五周年之际为你提供了全新的服务 —— JavaDoc 文档自动生成以及托管 (免费)。

比如这么一个项目 https://gitee.com/ld/J2Cache ,点击“服务” 里的 “JavaDoc”

三分钟上手 JavaDoc 在线生成和托管-Gitee 官方博客

然后点击"生成 JavaDoc"

现在可以通过 https://apidoc.gitee.com/ld/J2Cache/ 来浏览项目的 API 文档了。

把这个 JavaDoc 地址添加到你网站的首页,让用户可以一眼看到它,提升 30\% 技能。

别的语言还要等等哦,陆续推出。

三分钟上手 JavaDoc 在线生成和托管-Gitee 官方博客