3

JavaDocが生成するものと同様のシェルスクリプトを文書化できるオープンソースまたはパブリックドメインのフレームワークはありますか？これを特定の種類のシェルスクリプトだけに限定する必要はありません。理想的には、拡張が簡単な、または自己文書化の方が優れているWebページでAPIまたはコマンドラインタイプのコマンドを文書化するための汎用フレームワークが必要です。

4

4 に答える 4

4

Perl を使用している場合、シェル スクリプトのドキュメント化に Perl の POD システムを使用した例を次に示します。

秘訣は、null コマンド (no-op) の直後に、bash の「Here-Document」に Perl POD セクションを配置すること:です。

  • 皮切りに: <<=cut
  • POD 形式の man ページを作成する
  • それでおしまい。POD は で終わります=cut。これは、シェルのヒアドキュメントの終わりとしても定義されています

作成したスクリプトは、perldoc や perl2html などのすべての通常の Perl ツールで処理でき、pod2man で実際のマニュアル ページを生成することもできます。

例として、podtest.shスクリプトは次のとおりです。

#!/bin/dash

echo This is a plain shell script
echo Followed by POD documentation

: <<=cut
=pod
=head1 NAME

   podtest.sh - Example shell script with embedded POD documentation

...

No rights Reserved

=cut

この podtest.sh を man ページに追加するには:

 pod2man podtest.sh >/usr/local/share/man/man1/podtest.sh.1
于 2008-10-21T16:20:58.920 に答える
2

Doxygen は bash スクリプト ファイルをサポートしていませんが、Doxygen を bash で動作させることができます。

ドキュメントがコードとは別のものであることを気にしない場合は、間違いなくronnをチェックしてください。

また、JavaDoc と同じではありませんが、 Shoccoも役立つ場合があります (コードはドキュメントの不可欠な部分です)。

于 2012-10-10T14:38:27.803 に答える
0

あなたはDoxygenを検討するかもしれません。これは主にJavaDocのようなC風の言語を文書化するために使用されますが、少しラングリングのあるシェルスクリプトで機能するセットアップを思い付くことができるでしょう。

于 2008-10-21T16:02:29.953 に答える
0

ドキュメント化されたシェル スクリプトの標準的な方法は、C に似たスクリプト コメントで troff を使用することです。ただし、troff/ pod/rdoc/jdoc コード。

于 2012-10-19T02:24:09.760 に答える