protocols - プロトコルドキュメントの書き方

Question

ゲームのプロトコルを書いていますが、そのためにどのソフトウェアを使用すればよいかわかりません。

Microsoft WordやExcelで書いてみましたが、読みやすく編集しやすいとは限りません。

それを助けることができる良い習慣やツールはありますか？

Answer 1

プロトコルを記述するための標準的なツールは、通信業界 (およびその他) で何十年も使用されてきたメッセージ シーケンス チャートです。

これは、最も確実に学習して使用する必要がある、非常に強力なツールです。http://sourceforge.net/projects/msc-generator/を使用してチャートを編集および生成することをお勧めします。

Answer 2

これにはdoxygenを使用できます。プロトコルのドキュメントをソースのどこかに実装するか、スタンドアロン ファイルを作成することができます。Doxygen は通常、ソース ドキュメントに使用されますが、これにもうまく機能するはずです。

Doxygen はmscgenも実装しており、目的に応じて便利になるはずです。