― Web Technology and Life ―

Perlモジュールのドキュメント(Pod)の書き方

2011-12-04
ちょっとメモです。そのうちふくらましていきます。

NAMEの書き方

モジュール名と「イケている」コピーを書く

DESCRIPTIONの書き方

NAMEの「イケている」コピーを説明した内容にする。それほど長くならないように、ただ具体的にそのモジュールがなんなのかがわかるように言葉を選んで書く。

SYNOPSIS項目の書き方

SYNOPSISのコードをコピペして動かすだけで、なんとなく概要がわかるようなものを書く。

method項目を書くときの注意点

  • 概要
  • 引数
  • リターンバリュー

その他

  • 特別に注意して特徴を述べたほうがいい場合は、一つ他のモジュールと比較したの優位性を書く
  • 人のモジュールのPODを読むときは、モジュールの使い方だけでなく、使い方をどのような英語で表現しているのか頭に焼き付ける
Perl update_at : 2011-12-04T18:03:48
hirobanex.netの更新情報の取得
 RSSリーダーで購読する   
blog comments powered by Disqus