documentation - パケットプロトコルを文書化する良い方法

Question

生のtcpソケットを使用して相互に通信するサーバーとクライアントを構築しました。パケットが相互に送信されたことを文書化するための良い方法は何ですか？

現時点では、ウィキアを使用してパケットごとに新しいテーブルを作成していますが、ループやより複雑な構造を持つパケットは読みにくく、ウィキアを維持するのは困難です。

したがって、パケットを表示しやすくしたり、さらに重要なこととして保守しやすくしたりするソフトウェアはありますか。

ありがとうございました

Answer 1

Protocol Buffersのようなものを使用する場合は、バイナリデータの高レベルの説明がすでにあります。一般に、適切なアプローチは、構造の高レベルの記述を何らかの方法で維持してから、シリアル化および逆シリアル化関数を生成するコードを作成することです。

次に、同じコードジェネレーターで人間が読める形式のドキュメントを生成することもできます。