Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationEventAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
33
Help us understand the problem. What are the problem?

More than 5 years have passed since last update.

@alucky0707

もっとみんなjavadoc.ioを使おう!

javadoc-io.png

javadoc.ioというサービスが素晴しいと思うのですが、日本語での紹介記事があまりなかったので紹介させてもらいます。

javadoc.ioとは?

Central Maven Repositoryで公開されているプロジェクトのドキュメントをホスティングするサービスです。

http://javadoc.io/doc/<org>/<artifact>/<version>

というURLにアクセスすると、対応するドキュメントを閲覧することができます。例えばOkHttpのv3.2.0であれば、

のようなURLになり、こんなドキュメント(と言ってもJava 8のJavaDocそのものですが)が表示されます。

javadoc-io-okhttp.png

よいところ

  • JavaだけではなくてScalaやGroovyにも対応している。
  • Central Maven Repositoryに上がっているプロジェクトであれば、どんなプロジェクトのものでも見ることができる。
  • フリー
  • 複数のバージョンのドキュメントをすぐに切り換えることができる。
  • ドキュメントをZipでダウンロードすることができる

従来であればJavaDocをGitHub Pagesなどで公開していたかもしれませんが、GitHub Pagesで公開する場合はGitHubのフックを使ってJavaDocをビルドしてアップロードする必要があったものを、URLを指定するだけでドキュメントを公開できるのは楽でいいのではないかと思います。

ダメなところ

  • Javaの標準ライブラリのドキュメントは見れない
  • Kotlinには対応していない模様
  • SonatypeJitPackといったリポジトリにも対応していない
  • GitHubの最新版のドキュメントが見れるわけじゃない
  • 初回にドキュメントを取得するため表示されず、一度リロードする必要がある。

と、ここら辺かなと思います。Kotlinに対応してたり、SonatypeやJitPackに対応していたら使える幅も広がるのですけど‥。

それと、GroovyDocがどういうプロジェクトなら表示されるのかよく分かりません。

また、最後の問題はタイトルにあるとおり、もっとみんなjavadoc.ioを使えば解消されるかもしれません(それでも生成が完了したら自動リロードしてくれる機能が欲しいものですが)

これらはこれからの更新に期待したいところです。

まとめ

Javaのプロジェクトを作ったら、javadoc.ioみたいなバッジを置いておくと便利なんじゃないでしょうか。

IDEの補完でドキュメントを見るだけだとライブラリの全体の設計が見えてこないことがあるので、こうしてドキュメント全体に一度目を通しておくことは大切だと思います。

それでは、こんなスクショで量を誤魔化した記事にお付き合いいただきありがとうございました。

Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
33
Help us understand the problem. What are the problem?