2016/07/22

[android]Android StudioでJavaDoc

Android Studio 2.1.2のWindows版でJavaDocを作ろう!
私は比較的、コメントをたくさん書くのが好きなのだ。


メニューから「Generate JavaDoc...」を選択。

image

そうするとダイアログが出てくる。
設定して、一番下のOKを押すと生成される。

Other command line argumentsに-encoding UTF-8 -charset UTF-8」を書いておいた方がよいと思う。
お客様にリリースしたら、IEとChromeで文字化けしますっていわれてね。。。
Firefoxだと出ていたから安心していたのだよ。

 

私はモジュールだけJavaDocにしたかったのだけど、Custom scopeでコンボボックスからモジュールを指定しないと、R.javaとかBuildConfig.javaなんかも出てしまったのだ。
なんだろうね?


で、JavaDoc形式だ。

私はDoxygen形式でコメントを書くことが多いので、JavaDocも似たようなものだろうと思ってかなり失敗した。
今もうまく書けたと思ってない。

きれいに見せたかったら、ソース上での見栄えはあきらめて、HTML形式で書くのがよさそうだ。
<br>と<ul>~</ul>だらけになってしまった。

改行は<br/>じゃなくて<br>にしないとエラーになる(警告だったかも)。
どうも、後ろにスラッシュが来るタイプはダメらしい。

あとは、/**< ~ */とか///< のような後置タイプは使えない。
あれはdoxygen用のようだ。
おかげでenumとかpublic finalにした固定値なんかの説明で縦が長くなってしまった。

 

そういうのをあきらめれば、比較的まともな見栄えのコメントになるようだ。
Android Developersみたいに、引数や戻り値をテーブル形式にしたいのだけど、そこまではわからなかった。

0 件のコメント:

コメントを投稿

コメントありがとうございます。
スパムかもしれない、と私が思ったら、
申し訳ないですが勝手に削除することもあります。