Javadocについて学ぼう☆彡

2023.5.19

こんにちは!0円スクールです(/・ω・)/

最近暑い日が続いていますが皆さんいかがお過ごしでしょうか(/・ω・)/
私は朝活を始めました(^^♪
毎朝出勤の時に早めに出て散歩がてら歩いています♪
朝日光をしっかり浴びているので1日元気な気がします(*’ω’*)おすすめ♪

============================================================
さて。話しは変わりまして。。。

今回のタイトルである《javadoc》についてちょっとお話ししようと思います。

Java言語で良く登場するメソッド。
自由に書くことは出来ますが、引数に何が求められるのか?そもそも何をするためのメソッドなのか。
メソッドに対しての説明書があると、非常にありがたいですよね。

そんな時便利なのがJavadocです(^^♪

そもそもJavadocとは何なのか。
簡単に言うととあるコマンドで自動作成されたソースコードの説明書です。

例えば「このメソッドにはこんな値を渡しますよ~」とか「このメソッドからはこんな値が返ってきますよ~」
等の情報がまとめられたホームページっぽい形の説明書です。

ではJavadocには何が書かれているのか。

①ソースコードの構造から機械的に読み取れるもの
②特定の書式で書かれたコメント

この2つです。

ソースコードの構造から器械的の読み取れるものとは何か。
クラス名やメソッドの種類、戻り値などです。
メソッドの中身などは読み取りません。

では特定の書式で書かれたコメントとは何か。
そもそもJavaのソースコードの中にはコメントを書くことができます。
コメントというのは簡単に言うとソースコードに書いておく人間用のメモ書きみたいなものです。

この2つがまとめられたホームページっぽい形の説明書です。

故に、Javadocを利用しましょう。
一言でいえば、説明書を付与できると思っていただければ大丈夫です!
是非、まだ知らない方はこの機会に調べて活用してみましょう!


============================================================
最期にお知らせです( ^ω^ )

0円スクールでは現在受講生を募集中です^^
気になる方は是非説明会に参加してみてください(*^-^*)平日毎日開催中です♪
お申し込みはこちらから!

============================================================

0円スクールは受講生を随時募集中です!
あなたからのご応募お待ちしております!

お申し込みはこちらから!

あなたも、0円スクールで、一緒に無料でJavaを勉強しましょう!

■0円スクールへのお問い合わせ、お申し込みはこちらから!
Javaを0円で学ぼう!0円スクール
■株式会社ブレーンナレッジシステムズHP
株式会社ブレーンナレッジシステムズ