私は C プロジェクトに取り組んでおり、さまざまな作成者とさまざまなドキュメンテーション スタイルを見てきました。
私はdoxygenやその他のドキュメント生成ツールの大ファンで、このプロジェクトを移行してこれらのシステムの 1 つを使用したいと考えています。
ソースコードのコメントをスキャンして、「説明」、「作成者」、「ファイル名」などのキーワードやその他の種類のコンテキストをスキャンして、コメントを標準形式にインテリジェントに変換できるツールを知っている人はいますか? そうでない場合は、クレイジーなスクリプトを作成するか、手動で変換できると思います。
ありがとう
Lex + Yaccに関する O'Reilly の本を読んだときに思いつく唯一のことは、コマンド ラインにコメントを出力するコードがあったことです。第 2 章には、コメントのコードを解析する方法を示すセクションがありました。//と/*..*/...サンプルのページにリンクがあります。ファイル progs.zip をダウンロードしてください。探しているファイルは、ch2-09.lビルドする必要があるファイルです。コメントを出力するように簡単に変更できます。次に、それをスクリプトで使用して、「名前」、「説明」などを除外できます...
興味があれば、これを行う方法に関する指示をここに投稿できますか?
編集:私はあなたが探しているものを見つけたと思います.ビルド済みのコメントドキュメントエクストラクタhere .
これがお役に立てば幸いです。よろしくお願いします、トム。
解析するスタイルのセットが比較的限られている場合は、ファイルを検索する Visual Studio マクロ (IDE で使用するため) またはスタンドアロン アプリケーション (ソース コードを「オフライン」で処理するため) を記述するのはかなり簡単です。コメントを分割して、特定のタイトルまたはタグを使用して新しいスタイルに再フォーマットします。
AtomineerUtils Pro ドキュメンテーションアドインを使用すると、簡単に作業を進めることができます。ソース ファイル内のすべてのコメントを 1 回のパスで検索して変換できます。XML ドキュメント、Doxygen、JavaDoc、および Qt 形式 (またはそれらに十分近いもの) を解析し、それらの形式のいずれかでコメントを出力できます。互換性のない従来のコメントを変換するように構成することもできます。変換を支援するオプションはいくつかありますが、最も強力なのは Visual Studio マクロを呼び出す方法です。これにより、少し文字列処理を適用して、従来のコメントを AtomineerUtils が後で読み取ることができる形式に変換できます (最も一般的に使用されている従来のスタイルの 1 つのサンプル マクロが Web サイトで提供されているため、コンピューターが解析するのに適している限り、通常、これを変更してレガシー形式に対処するのは非常に簡単です)。
変換されたテキストは特に整然としている必要はありません - AtomineerUtils がドキュメンテーション エントリを抽出できると、コメントがクリーンアップされます - オプションで、ワード ラップ、一貫した要素の順序付け、間隔などを自動的に適用し、コメントがコード要素を正確に説明するようにします。それは文書化され（そのエントリはparams、typeparams、スローされた例外などと一致します）、構成された形式で置換コメントを出力します。これにより、変換マクロを整理するために多くの作業を行う必要がなくなります。また、変換が完了したら、引き続きアドインを使用してコードを文書化する時間を節約し、すべての新しいコメントが同じスタイルで続くようにすることができます。
tommieb75が示唆するように、適切なパーサーがこれを処理する方法だと思います。
ANTLRを参照することをお勧めします。これは、トークン バッファーのインプレースの書き換えをサポートしているためです。これにより、空白などを保持するために必要なことを最小限に抑えることができると思います。 The Definitive ANTLR reference の9.7 章を参照してください。