モジュールPOD

モジュールPOD
Perlモジュールのドキュメントは、POD(Plain Old Documentation)という簡単なマークアップ言語で書かれています。

このページは、PerlモジュールのPODを記述する方法を示しています。 このスタイルを遵守すれば、他の人があなたの文書を読んで理解しやすくなります。

h2xsは、それが書き込む.pmファイルの最後にスケルトンPODを置きます。 追加の例については、既存のモジュールのPODを参照してください。

 = head1 NAME

ジオメトリ::サークル - サークルを管理する
NAMEセクションには、モジュールの名前と1行の説明が表示されます。名前と説明はダッシュで区切られています。 PODを適切なマニュアルページに変換できるように、この形式を守ることが重要です。
 = head1

   Geometry :: Circleを使用する

   $ circle = new Geometry :: Circle $ x、$ y、$ r

   ($ x、$ y)= $ circle-> center;
   $ radius = $ circle-> radius;
   $ area = $ circle-> area

   $ pi = $ジオメトリ::サークル:: PI;
SYNOPSISセクションでは、useステートメント、サブルーチン、クラスメソッドまたは変数、およびすべてのオブジェクトメソッドを使用してモジュールを使用するための基本的な手順を示します。 メソッド呼び出しは、それらのパラメータと戻り値を示す必要があります。概要の各行をインデントします。 これはそれを逐語的なパラグラフにして、あなたの配置が確実に保持されるようにします。
 = head1が必要です

 Perl5.8.8、エクスポータ、Geometry :: Point
REQUIRESセクションは、モジュールを使用するために必要なものをユーザーにREQUIRESします。
 =ヘッド1 EXPORTS

何もない
EXPORTSセクションでは、モジュールをuseする場合、そのモジュールが名前空間に何をするかをユーザーにEXPORTSします。
 = head1 DESCRIPTION

 Geometry :: Circleはサークルを管理します。  
作成するためのメソッドが用意されています 
サークルとその領域を計算します。
これはモジュールの説明です。プログラマーではなく、ユーザーに関連する言葉で書かれていなければなりません。

  • それはユーザーのために何をするのですか?
  • あなたはどうやってそれを使いますか?
  • どのオブジェクトがサポートしていますか?
  • それはどのような方法で提供されますか?
 = head1方法

 = head2作成

 = 4以上

 = item新しいGeometry :: Circle $ x、$ y、$ radius

 aを作成して返します。 
新しいGeometry :: Circleオブジェクト 
中心($ x、$ y)と半径$半径を持つ。

 =戻る

 = head2アクセス

 = 4以上

 = item $ circle-> center

 x、y座標のリストを返します。 
円の中心の

スカラーコンテキストでは、 
配列参照を返します。

 = item $ circle-> radius

円の半径を返します。

 = item $ circle-> area

円の面積を返します。

 =戻る
METHODSセクションでは、クラス内の各メソッドをリストして説明します。Creation 、 Access 、 Utilityなどのレベル2見出しの下にメソッドをさらに編成することができUtility 。
 = head1クラスのバリエーション

 = 4以上

 =アイテム$幾何学::サークル:: PI

円周率 
その直径に対する円の直径である。

 =戻る
CLASS VARIABLESセクションには、APIのパッケージ変数がリストされています。
 =頭部診断

 = 4以上

 = item負の半径

 (F)半径が負の円を作成することはできません。

 =戻る
DIAGNOSTICSセクションでは、モジュールが生成する可能性があるすべてのエラーメッセージのテキストと、その意味を説明します。エラーメッセージは次のように分類されます。

(W)
警告(オプション)
(D)
非推奨(オプション)
(S)
重大な警告(必須)
(F)
致命的なエラー(トラップ可能)
(バツ)
非常に致命的なエラー(非トラップ可能)
 = head1作者

 AU Thor、author@a.galaxy.far.far.away
誰かがモジュールに関してあなたに連絡を取る必要がある場合に備えて、あなたの名前と電子メールアドレスを含めるべきです。
 = head1関連項目

 perl(1)、Geometry :: Square
これは、関連するプログラムとモジュールの通常のリストです。
 =カット
=cutラインは、PODテキストの最後を示します。ソースコード全体にPODセクションを配布する人もいます。 PerlはPODセクションを認識し、それらを無視します。

No Comments

    Leave a reply