sdfget - クラウド上のオンライン

プログラム：

NAME

sdfget - ドキュメント抽出ユーティリティ

目的

sdfget ソースコードに埋め込まれたドキュメントを抽出します。

USAGE

使用法: sdfget [-h[help]] [-o[out_ext]]
[-l[log_ext]] [-O[out_dir]]
[-f フォーマットファイル名] [-g[get_rule]]
[-r[rpt_file]] [-s スコープ] [-i]
[-v[verbose]] ファイル ...
目的: ソースコードに埋め込まれたドキュメントを抽出する
バージョン: 2.000 (SDF 2.001)

オプションは次のとおりです。

オプションの説明
-h オプションのヘルプを表示します
-o 出力ファイル拡張子
-l ログファイル拡張子
-O 入力ファイルの (または明示的な) ディレクトリに出力します。
-f 出力のフォーマット時に使用するファイル名
-g ドキュメントを取得するために使用するルール
-r レポートファイル
-s 抽出するドキュメントの範囲
-i 抽出されない行のみを出力します
-v 詳細モード

DESCRIPTION

-h オプションはヘルプを提供します。 パラメータなしで指定した場合は、簡単な説明
各オプションの が表示されます。 オプションの属性を表示するには、オプションを指定します
パラメータとして文字を指定します。

デフォルトでは、生成された出力は標準出力に送られます。 入力ごとに出力をファイルに送信するには
ファイルの場合は、-o オプションを使用して出力ファイルの拡張子を指定します。 -o オプションが
パラメータなしで指定すると、次の拡張子が返されます。 でる 想定されます。

同様に、エラー メッセージはデフォルトで標準エラーに送られます。 -l オプションを使用して、
入力ファイルごとのログ ファイル。 -l オプションをパラメータなしで指定した場合、拡張子は
of ログ 想定されます。

デフォルトでは、生成された出力ファイルとログ ファイルは現在のディレクトリに作成されます。 使用
-O オプションを使用して、明示的な出力ディレクトリを指定します。 -Oオプションを指定せずに指定した場合
パラメータの場合、入力ファイルのディレクトリが使用されます。

-f オプションを使用すると、出力をフォーマットするときに使用するファイル名を指定できます。 これは
テキストが標準入力ストリームから来る場合に便利です。

当学校区の 取得ルール 抽出する埋め込みドキュメントのフォーマットを指定します。 全て
現在定義されている get ルールは、ドキュメントがいずれかのコメント ブロック内にあることを前提としています。
次の形式：

>>セクションタイトル1::
セクション 1、1 行目のテキスト
セクション 1 のテキスト ..

>>セクションタイトル2::
セクション 2、1 行目のテキスト
セクション 2 のテキスト ..
>>終了::

>>section_title3:: セクション 3 のテキスト

最初の形式が最も一般的に使用されます。 この形式では、セクション内のテキストは次まで続きます。
現在の「コメント ブロック」の終わり、または次のセクションの始まりのいずれかになります。
初め。 XNUMX 番目の形式 (つまり、セクションの終了位置を明示的に指定する) は、次の場合に便利です。
望ましくない通常のコメント (つまり、ドキュメント以外) を追加したい場合
抽出された。 テキストが短い場合は、XNUMX 番目の形式を使用できます。 フォーマットに関係なく、
すでに定義されているセクションが見つかった場合、セクションのテキストが連結されます。
既存のテキスト。 これにより、各エンティティのドキュメントを指定できるようになります。
ソースコードで定義されている場所のすぐ上にあります。

-g オプションは、 取得ルール 使用します。 利用可能な get ルールはプレフィックスによって異なります
以下に示すように、各行の先頭に期待されます。

ルールプレフィックス
パール #
cpp //
c * または /*
fortran c (前に 5 つのスペースあり)
エッフェル --
バットレム

C コード内では、上記の文字の後に末尾のスペースが必要です。 他のために
言語の場合、末尾のスペースはオプションです。 FORTRAN コード内では、「c」文字は次のようにする必要があります。
前にちょうど 5 つのスペースが入ります。 他の言語の場合、XNUMX 個以上の空白文字は次のようになります。
上の文字の前に置くことができます。

たとえば、C コード内に埋め込まれたドキュメントは次のようになります。

/* >>目的::
* このライブラリは高レベルのインターフェイスを提供します
* 一般的に使用されるネットワーク サービス。
*/

-g オプションを指定しない場合、 パール はデフォルトの get ルールです。 -g オプションが
パラメーターを指定せずに、ファイル名の小文字の拡張子 (または
書式設定 ファイル名 テキストが標準入力からのものである場合) を推測するために使用されます。
get_rule は以下のようになります。

ルールの拡張
cpp cpp、c++、cc、hpp、hpp、h、java、idl
CC
fortran fortran、for、f77、f
エッフェル エッフェル、エイダ
バットバット、cmd

レポートのファイル名は、-r オプションを使用して指定できます。 名前に
拡張子として、SDG が想定されます。 レポートは次のメカニズムを提供します。

· セクションを選択的に抽出する、および

· 基本的な再フォーマット (例: SDF)

レポートが指定されていない場合、すべてのセクションが次の形式で出力されます。

セクションタイトル1
セクションテキスト1

セクションタイトル2
セクションテキスト2

-r を単独で指定した場合、 デフォルト.sdg と想定されます。 このレポートでは、次のセットを選択します。
セクション（ SDF 文書標準) ユーザー文書を形成し、
それらを次のようにフォーマットします SDF。 レポート形式の詳細を以下に示します。 レポートは
現在のディレクトリ内で検索され、次に 標準ライブラリ SDF のライブラリ内のディレクトリ
ディレクトリにあります。

-s オプションを使用して、抽出するドキュメントの範囲を指定できます。 （これ
は実験的な機能であり、変更される可能性があるため、ほとんどのユーザーは使用を避けるべきです)。

-i オプションは、get-rule に一致しなかった行のみを出力します。 このオプションは
ファイルからドキュメント以外の部分を抽出してコードのみを提供する場合に便利です。

注意： -i が指定されている場合、-r オプションは無視されます。

-v オプションは冗長モードを有効にします。 これは、どのルールが何に使用されているかを確認するのに役立ちます。
各ファイル。

例

ユーザードキュメントを SDF C++ で書かれたアプリケーション (XYZ、と言う）そして
に保存します xyz.sdf:

sdfget -gcpp -r -osdf xyz.cpp

制限 そして 未来 道順

get-rule が常にファイル名の拡張子から推測されればもっと良いのですが、
Perl からデフォルトを変更すると、既存のスクリプトが壊れる可能性があります。 したがって、get-rule の推測
パラメーターを指定せずに -g オプションを指定して、明示的に有効にする必要があります。

onworks.net サービスを使用してオンラインで sdfget を使用する