1

新しい通信プロトコル (この例では TFTP を使用します) を作成していて、Word ドキュメントに次の表があるとします (形式は異なる場合があります)。

Opcode   |  2 bytes
filename | string
padding  | 1 byte = 0
mode     | string
padding  | 1 byte = 0

コードを書くときは、次のような構造を作成します。

class TFTP_packet:
    short opcode
    string Filename
    byte   padding=0
    string mode
    byte   padding2=0

私には、繰り返しの作業をしているように思えます。現時点では、正規表現を使用して高速化していますが、このデータをカプセル化して、ドキュメントに簡単に表示したり、コードに簡単に変換したりできる方法はありますか? ドキュメントから構造を分離する方法はありますか?

4

1 に答える 1

0

仕様 (プロトコル) は、コードが何をすべきかを定義します。コードのバグが仕様のバグにならないように、ソースから仕様を (再) 生成したくないでしょう。

CASE ツールは、詳細な設計と生成されたソースを同期させようとしますが、成功することはめったにありません。その道を選ぶなら頑張ってください。通常、設計ドキュメントは最初にコードを開発するために使用されますが、アーカイブの保守されていない歴史的な成果物になります。

一方、最新のドキュメントは、コードから必要に応じて比較的簡単に生成できます (例: javadoc (java) や doxygen (c++) など)。 （しゃれは意図されていません）コンテンツの、そして最終製品を生成します。つまり、2 つ (またはそれ以上) の場所で同じ説明、同じテーブル、同じデータ構造を維持したくないということです。これは、すべてを 1 か所 (msword XOR ソース) に文書化する必要があるという意味ではありません。むしろ、(ソースから) 生成されたコンテンツを既存の外部文書 (文書内) にマージすることをお勧めします。

しかし、これをさらに一歩進めるために、Word (柔軟性がなく、プラットフォームに依存し、自動化が難しい) を使用する代わりに、OpenOffice (LibreOffice) の「マスター」ドキュメント ( *.odm) を使用して、通常のドキュメントを取り込んでマージすることをお勧めします ( *.odt) 。生成された画像とテキストフラグメント (ソースコードから生成されたもの、またはテストプログラムの入出力から生成されたもの)。生成されたドキュメントのビルドは、スクリプト化 (pdf 生成を含む) することも、全体的なソース コード ビルド プロセスに組み込むこともできます。

于 2012-06-07T08:28:25.267 に答える