Perl には Perl Docs ジェネレーターがありますか? Java Docs や PHP Documenter のようなものですか?
3576 次
4 に答える
14
はい、それはperldocと呼ばれます
javadoc と同じように、ソースにドキュメントを記述するだけです。
簡単に言えば、"=item" は箇条書きの項目です。たとえば、関数またはパラメータ "=over" は識別のレベルを下げ、"=back" はレベルを上げます。perl コードに戻したい場合は、「=cut」を使用します。
以下に例を示します。
=item $b->add_module ( %options )
Initialize a module. A module is a repository or a branch of a repository.
Valid options are
=over
=item id
Id of this module
=item repo
Url of repository. Currently only subversion repositories are supported.
=back
=cut
sub add_module($%)
{
perldoc プログラムに perl コードを渡すだけで、書式設定されたドキュメントを取得できます。
于 2010-01-25T16:54:24.763 に答える
7
于 2010-01-25T16:54:35.363 に答える
7
なぜいいの。はい、そうです！パールドック。
于 2010-01-25T16:54:42.037 に答える
2
[グーグルのためだけに]人々がすでに言ったように、あなたはPODでドキュメントを作成します（コメントではなく、コメントはメンテナのためのものであり、ポッドはユーザードキュメントのためのものです）。通常、スクリプトまたはモジュールの最初と最後、および各メソッドの前にPODを追加するとperldoc your_module、コンソールで使用したりpod2html、htmlに変換してサーバーで参照したり、pdocを使用したりできます（少し古いです）。ただし、WebドキュメントナビゲーターとWeb内のコードへのリンクが必要な場合に非常に役立ちます）。
ポッドのフォーマットについての新しい質問があります。これもあなたの興味の対象になる可能性があります perl-documentation-pod-browsers
そしてこれはhow-can-i-generate-html-documentation-for-perl-code-comments
そして、pod2htmlを実行し、cssファイルを使用してcpansearchページを模倣することについて話している別の人がいましたが、私は今それを見つけることができません。
于 2011-05-25T11:12:10.073 に答える