Android StudioでJavaDoc生成のメモ
はじめに
現在SI系の案件の仕事をしていて、ちょっと変わったことをしていたのでメモ
多分他のところではやらんのだろうなーとは思う
動作環境
- Windows 10
- 8G
- AS 3.0.1
- gradle plugin 3.0.1
- gradle runtime 3.5.1
作業的なメモ
- メニューの Tools > Generete Javadoc 実行
- CutomScope指定
- 自分が作ったパッケージのみ指定
- スコープはpublic
の手順で殆ど同じなのですが
Other command line arguments
は -bootclasspathは要らなかったけど
が必要な感じで*1
記載的なメモ
package-info.java
jenkinsのjavadoc生成pluginで生成すると、無いとエラーになるみたい で追記必須になってました
でもこのせいで、作るpackage配下が全部直列*2みたいな形になっててちょっと微妙な運用
生成用gradle plugin
しらべてみたらgradleのpluginもあるみたいだなー
複数行コメント
literalは不等号用のタグみたいな説明出ますけど、複数行文章が余計な空白なしに出る感じ
<p> タグだと変な空行が入って駄目
みたいなんだよな*3
<pre>
{@literal
ああああ
いいいい
うううう
}
</pre>
seeアノテーション
- これでクラス参照書くと80行越える
- checkstyleで怒られる
- 受け入れ先のお客さんだとjenkinsビルド*4担当の方がいてこの手の警告ログでると大騒ぎな話があるらしい
っていうのどうにかならないのかなーとかよく思う。除外設定とか無いものなんだろうか
参考
http://www.ne.jp/asahi/hishidama/home/tech/java/javadoc.html
確認にあると便利な奴 (macのopenコマンドなやつ)
生成後にindex.htmlを自動で開く みたいな事ができないのであると便利。
- open.bat
cmd.exe /c start %*
なの作っておくと楽。
pycharmでsphinx build実行する時、作成後にbrowser参照 とか出来るんだけど
これ独自ダイアログだから無理なんだよね・・・（汗
