# CPAN モジュールの使い方を調べる

CPAN モジュールの使い方がよくわからないよーという初心者向け。

## SYNOPSIS

CPANモジュールのドキュメントにはおおむね SYNOPSIS の項目があります。SYNOPSIS には主だったモジュールの使い方が書かれているので、まずはここを見てみましょう。

## METHOD

ドキュメントの METHOD の項目にはメソッドごとの詳細が書かれています。引数に何を渡せばよいか、返り値は何が返ってくるか、そうしたことが書かれています。

## t

SYNOPSIS や METHOD に十分な情報が載っていないモジュールもあったりするでしょう。そういったモジュールは長い目で見ると利用しない方が賢明かもしれませんが、絶妙に簡単なインターフェースのモジュールなどはドキュメントがばっさり割愛されていたりします。そうでなくてもドキュメントが十分でないことはままあることです。

そんな場合は t ディレクトリを覗いてみましょう。t にはテストがあります。ドキュメントが十分ではなくても、実はテストケースに利用ケースが揃っていることもあります。テストはモジュールのインターフェースを明示するものでもあるのです。

## example.pl

もし、モジュールのディストリビューションに example ディレクトリや、example.pl があったら、それはサンプルコードなので開いて見てみましょう。おおむね、そのまま実行できるコードが書かれています。

## ソースコード

使い方を調べるなら真っ先にソースだろ、という意見もあるかと思いますが、いったん初心者向けということでこの位置なのですが、ソースは間違いなくモジュールの一次情報です。ソースを読んでインターフェースを調べれば、大概は使い方を知ることができるでしょう。実装上の問題で、インターフェースが容易にわからない場合もあるかもしれません。とはいえ、ソースはモジュールを評価するにも全体目を通す必要はあるでしょう。

## ググる

正解がわかっていて、そこに辿りつくための検索エンジン利用は便利ですが、そうではなく、わからないことを検索エンジンで調べるときは注意が必要です。なんらかのモジュールを検索したとき、最新の良い正しい情報が上位の結果にくるとは限らないからです。古い、過去には有効だっただけの情報が上位にきていたりするからです。そのあたりを踏まえて検索結果と向き合いましょう。

## コミュニティで質問してみる

どうしても不明点がぬぐえない場合、lingr::perl や #perl-casual で質問するのもありでしょう。回答だけでなく、付帯情報、大喜利、ダジャレなども楽しめるかもしれません。もし質問する場合は、日本語でうまく説明できるなら不要かもしれませんが、できれば検証コードがあると不明点が伝わりやすくなると思います。

## See Also

* [[http://blog.64p.org/entry/20080520/1211292598 CPANソムリエになる方法]]  
CPAN モジュールを評価する方法が書かれています。