問題タブ [perl-pod]

Perlコードを文書化する方法について何か提案はありますか？何を使用し、どのツールを使用して私を支援できますか？

ポッドをHTMLに変換するためにどのモジュールを使用しますか？

次のようなPODがあります

pod2htmlコマンドはそれを

問題は<a href="#item_close"></a>. 私はこれが役立つと思っていますが（ が=item func()関数定義の開始である一般的なケースで）、私の場合は不適切です（警告メッセージです）。

pod2html=item open()が関数定義として表示されないようにするために、次のことを試みました (成功しませんでした)。

最後の 2 つは "(" を出力しません。E<> を間違って使用していますか? これは pod2html のバグですか (私は OS X で Perl 5.8.8 を使用しています)?

考えたブライアンの答えに基づいて、私は別の実験を試みました：

結果は になるはずでしたが、代わり<code>close<) on unopened filehandle %s</code>に生成されました。<code>close) on unopened filehandle %s</code>だから、pod2html数値エンティティが好きではないようです。

独自のカスタム コマンド用に POD を作成し、pod2usage() 関数を使用してその構文を表示したいと考えています。

誰でも簡単な例を教えてもらえますか?

よろしく、 アナンダン

The L<name> formatting code allows you to set the display text for the link if you're linking to other POD, as in L<Display Text|link_dest>, but this isn't allowed for L<scheme:...> links, such as

How do I specify a display text for such links? Alternatively, how do I manually write such a link without the angle brackets being HTML entitized by pod2html?

私が探しているのは、画面上での優れたPOD読書体験です。

何年もの間、私は画面上でPerlのドキュメントを読むために、そしてそれを印刷するために構築された小さなカスタムプログラムを使用perldocまたはman実行してきました。印刷版は良いです：スクリプトは素晴らしい仕事をします。ただし、画面上の読み上げは苦痛です。xtermPod::LaTeX

• 検索することはできますが、幸運を祈ります。たとえば、のasセクションを見つけてDBIx::Class::ResultSetください。Lessはドキュメントの構造について何も知らず、一般的な英語の単語を検索しても意味がありません。
• 文書が私に言うたびに私は恐れますsee section so-and-so。素晴らしい。今、私はそれを見つけなければなりません。そして、私がいた場所に戻ることは簡単ではありません（それは私の無知が少ないことを示しているかもしれませんが）
• ドキュメントを参照してください。!perldoc foo動作しますが、2つのドキュメントを切り替えるのは困難です。ほとんどの場合、サスペンドを減らしperldocてシェルから実行することでこれを回避できますが、それはより多くのキーストロークであり、私は怠惰です。
• フォーマットには多くの要望があります。

目次をクリックして、そのセクションに移動できるようにしたい。その「他を見る」をクリックしてそこに行きたいです。等々。これまでのところ、私は2つの可能性を知っています。

• search.cpan.org、例DBIx::Class::ResultSet。インターネット接続が必要ですが、通常は問題ありません。
• Podbrowser。これを試し始めたばかりで、かなり見栄えがします。

私はDebianGNU/ Linux、LennyとSqueezeの両方を実行しています。ただし、これを可能な限り役立つものにするために、すべてのプラットフォーム用のプログラムを提案してください。

Safari Books Onlineからテンプレートを提供するページを見つけることができましたが、PODコメントを書いたことがないので、それがどれほど優れているか、または慣例と見なされる可能性のあるものが欠落しているかどうかはわかりません。

PerlスクリプトのPODコメントを書くときに従うべき規則は何ですか？SunのJavadocコンベンションのようなものはありますが、PODコメント用ですか？

Pod 用の使いやすい「見たままのものが得られる」エディタはありますか?

私はまだ Pod 構文に慣れていないので、Pod を記述して出力がどのようになるかをすぐに確認できるオプションがあると、非常に役立ちます。理想的には、このエディターには、正しい構文を支援するためのある種の「コード補完」があります。

こんな編集者いる？

ディレクトリツリーにperlモジュールまたはスクリプトのHTMLサマリーリストを作成できるツールはありますか？

与えられた

私は次のようなものを見たいです

POD を使用して多言語ドキュメントを作成する方法はありますか? いいえの場合、どのように記述すればよいですか (英語の POD ドキュメントが既にあるので、変換してから翻訳したいと考えています)。