自動ドキュメンテーション - 迅速なパーサを作成するための最善の方法

Question

私は、エンドユーザーはそれがコメントやや冗長が必要ですので、編集する必要があるという大きなスクリプトを持っています。私は、これに似た私のファイルのレイアウトを使用します。

//********************
//
// FileName
//    This script contains:
//    - Function X - does something
//    - Function Y - does something else
//
//********************

//********************
// Function X
// does something (<< I'd only like to enter this part once)
//********************
// Code here...

//********************
// Function Y
// does something else
//********************
// Code here...

私は、ファイルのヘッダに機能要約のコピー/貼り付けを行い、簡単なパーサを作成します。私はANTLRも正規表現のように、これを達成するために助けることができるいくつかのツール、を知っているが、何が最善の方法でしょうか？

Answer 1

あなたが言及二つのオプション、ANTLRや正規表現を考えると、私はANTLRをお勧めします。 ANTLRは、長期的にはより柔軟になり、私は（それが文法に基づいて、解析する）あなたがより効果的に使用することができるはずと信じています。 あなたはいくつかのカスタム・ロジックやその他もろもろに追加しない限り、正規表現のアプローチは、正規言語に制限されます。

例として、私はあなたが困難正規表現でブロック対外ブロック内のコメントを識別しています疑い。 CFGは、そのような区別がうまく作ることができるはずです。あなたがソースを管理している場合はその後、再び、あなただけのコメントの種類が表示されます何のためにいくつかの仕様書を作成可能性がどこ...