ドキュメントの読み方

JavaDocの読み方

JavaDoc = spigot API 一覧

一覧を見ることができるようになると「何ができて、何ができないか」が分かるようになる。

英語で書いてあるが、英語と日本語を行き来して見るようにする。
Web業界で使われる英語と日本語をつなぎ合わせるようになれると英語でこう書いてあるやつは、こうゆうやつなんだなと解るようになる。

例としてeventの見方

eventののなかのplayerを見てみる。

ここで、今回使っていた「PlayerBedEnterEvent」を見てみると

これは、パッケージではなくクラスなので見え方が代わってくる。

一番上の

java.lang.Object
 org.bukkit.event.Event
  org.bukkit.event.player.PlayerEvent
   org.bukkit.event.player.PlayerBedEnterEvent

は、クラスの継承関係がどうなっているかがわかる。

その下で分かるのは、インターフェイスとして実装されているのは、「Cancellable」であるということ。

インターフェイス = 便利になるようにつなぎ合わせるもの(例えば:UI)

Nested Classesは、インナークラスのこと。

Field Summary は、フィールドにはplayerというものがあるということ。

Method Summary は、メソッドの種類
getBed()は、ヘッドに入ろうとしたときのベッドの情報をくれる。
isCancelled()は、trueにするとベッドに入ろうとすることをcancelするようになる。
(イベントが発生したときにそれをキャンセルするということもできる)
getBed()のところを押すと「@NotNull」と書いてあるので、Nullは許容しないということで、絶対ベッドブロックが返されるということが書いてある。

ここで、blockの部分をクリックするとbllockの中身が見れる。

そんなふうに、各階層に入っていくことで何ができるのかが解るようになる。

JavaDocは、書くこともできるコメントアウト(緑色にする)することによって、何ができるのかを解説しているもの。
コメントアウトは、/**のあとにエンターで書き込むことができる。

よかったらシェアしてね!
  • URLをコピーしました!
  • URLをコピーしました!

コメント

コメントする

CAPTCHA


目次