読者です 読者をやめる 読者になる 読者になる

そこに仁義はあるのか(仮)

略してそこ仁!

JavadocってどうやってAPIドキュメントにするの?って思って調べてみたらお手軽だった

Gradle TOOL Java maven IntelliJ IDEA

JavadocからAPIドキュメントができるのは知ってたけど、
実際にはどうやって作るんだろうと思って調べてみたらすごく簡単だった。

Gradleを使う

Gradleで管理しているプロジェクトで、

gradle javadoc

コマンドを実行すれば、build > docs > javadoc にできる。

こんな感じで、Java7、Java8のAPIドキュメントっぽく生成される。

f:id:syobochim:20140810192546p:plain
f:id:syobochim:20140810192558p:plain
f:id:syobochim:20140810192605p:plain



私はPJをUTF-8でつくってるんだけど、
日本語文字列のエンコードでエラーになった。
build.gradleに以下のEncodingの設定を追加したら解決した。

追加した設定

javadoc {
options.encoding = "UTF-8"
}

おこったエラー

/Users/syobochim/dev/JUnitPractice/src/main/java/ch06/ItemStock.java:6: ???: ??????????????ASCII?????????
* ??????????????????????????????????????????
^


maven を使う

maven で管理しているプロジェクトで

mvn javadoc:javadoc

のコマンドを実行すれば target > site > apidocs にできる。

f:id:syobochim:20140810195515p:plain

Encodingのエラーは

[ERROR] * maven ?????????????????????????????????
[ERROR] ^
[ERROR] /Us


pom.xmlに以下の設定を追加したらなおった。

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

2014/08/14 追記

しおしおさんが優しく教えてくれた!
Intellij IDEAでJavadoc作成する方法!Intellij IDEAかわいいよぺろぺろ(^p^)

IntelliJ IDEAでJavaDoc生成を追記 - しおしおの雑記帳