Java APIリファレンスについて （Java学習中)

Question

JavaにAPIリファレンスというものがあり、そこにはパッケージやクラスについての情報がたくさんあり、得ることができるということを今知りました。

エンジニアとして、活躍するためには多くの知識が必要だと思いますが、みなさんはAPIリファレンスを利用していますか？
もし、利用されていたら活用法を教えていただきたいです。

また、他のもので知識を得ている場合はそれに関しても教えていただきたいです。

Answer 1

APIリファレンスを「活用」と言われると「えっ、そりゃ日々参照するけどそれを活用というのか」という思いです。
それでもあえてJava APIリファレンスの活用法を。

あれには日本語版も英語版もあります。
英語版の方を読むようにしてください。

理由の一つ目。逐語訳気味の（決して的外れな翻訳ではないのですが）日本語版より、原典の英語版の方が明解ですので、英語を読む労力を差し引いてもわかりやすいはずです。

二つ目。英語のお勉強です。最新のライブラリを使う機会がすぐに出てくるはずです。そういったものに日本語のリファレンスなんか付いていません。最初から英語で理解できないといけないのです。Java APIリファレンスはわからなかったときの対訳が用意されているわけで、技術英文の教材として最適です。

ちなみにC++やC#をやる人はまた別の英語のお勉強があります。
Microsoftの最近のリファレンス文書は日本語版がすべて機械翻訳なのでぐちゃぐちゃで、それをWeb上から見た人が修正できるようになっています。機械翻訳結果を原文と見比べながら修正するという、これはこれで効果的なお勉強となります。

Comments

[Takahito]

英語版の方を読むのですね。ありがとうございます！
試みてみます！

Answer 2

エンジニアとして活躍するのにも様々な形があると思いますが、Javaをマスターすることに特化するのであれば、APIドキュメントを使いこなすのは必須です。

良く使うクラスについてはできるだけ記憶しておくべきですが、そうでないクラスやメソッドをすばやく調べられるようにしておきましょう。

APIドキュメントはダウンロード可能ですので、頻繁に使うのであればダウンロードして使うと良いです。日本語訳バージョンもあります。
日本語版は下記ページからダウンロードできます。

Java SE 日本語ドキュメントアーカイブ (oracle.com)

yubaさんも書かれていますが、慣れてきたら、英語版もある程度読めるようになっておいたほうが良いです。

Javadocの読み方というページがあったので、リンクを貼っておきます。

プログラミング言語/Java/javadocの読み方 - プログラミングスレまとめ in VIP

Comments

[Takahito]

いつもありがとうございます。argiusさんにはいつも助けられています。
すばやく調べられるということが重要なのですね。
リンクも貼っていただきありがとうございます。今回は、先に教えていただいたyubaさんをベストアンサーとさせていただきました。

Answer 3

活用方法は、メソッド説明の例外項目をチェックします。
そうすると実装する際、例外をキャッチするかどうか考えるようになります。
つまり、起こりうる障害に対して、未然に対処する事ができるというわけです。

Comments

[Takahito]

例外のチェックに使うのですね。ありがとうございます。これをうまく使いこなせればバグなどを未然に防ぐことができそうです。

Answer 4

eclipse, netbeans では, javadoc を簡単に参照できるようになっています。

• eclipse 入門 APIドキュメントの表示 http://www.javadrive.jp/eclipse3/help/index3.html
• NetBeans で日本語の JDK Javadoc を設定する https://ja.netbeans.org/docs/techinfo/jajavadoc.html

自分で書くコードでも、javadoc コメントを書くようにすると良いです。

• Javadoc ドキュメンテーションコメントの書き方 http://qiita.com/maku77/items/6410c67ce95e08d8d1bd

Comments

[Takahito]

ドキュメンテーションコメントというものがあるのですね。自分自身だけでなく、チームなどで開発する際にはとても大切な要素になりそうな気がします。
ありがとうございます！