【Javadocとは】
---------------------------------------------------------------
Javadocとは?
Javadocは簡単に説明すると、Java言語のソースコードから「プログラムについて説明するドキュメント」を生成する仕組みです。
Javadoc用のコメントを記述すると、作ったプログラムに対するドキュメントをソースコードに埋め込んでくれます。
---------------------------------------------------------
≪独り言コーナー≫
Javadocはjavaのソースコードを解析する作業を貰ってて、上司から作業の説明されているときに出てきた言葉で
最初の認識としては、「javaの特定の機能とか調べるサイト」っていうなんかようわからん認識をしていたが
調べてみたら全く内容違っててなんでそんな認識をしたのか自分でも恥ずかしい、、、
(そもそもお題に挙げて調べてる今までのIT用語で内容がほぼおうてたこと一度もないけど)
Javadocは理解するのに結構時間がかかって色んなサイト回ったけど、下記に載せてる参照サイトが一番しっくりきました。
自分の理解した内容だと
「自分の今作っているプログラムの内容を簡単に資料形式でまとめてくれる便利なもの」
という理解で
資料を生成してくれる条件として
・Javadoc用のコメントを記述する
ことが条件
ということで頭の中にインプットしてます。
これ正直言葉で説明されてもイメージが全くわかんから、参照サイトを見たり自分で調べてみたりして
「資料が生成されるっていうけど、中身はどんな資料なの??」
とか
「Javadoc用のコメントってなに??」
みたいなところは自分で調べるとイメージがグッと沸くと思いました。