protocols - 如何编写协议文档

Question

我正在为我的游戏编写协议，但我不确定要使用什么软件。

我一直在尝试用 Microsoft Word 和 Excel 编写它，但阅读或编辑它并不总是那么容易。

有什么好的做法或工具可以帮助我吗？

Answer 1

您可以为此使用doxygen 。您可以在源代码中的某处实现协议的文档，也可以创建一个独立文件。Doxygen 通常用于源文档，但也应该适用于此。

Doxygen 还实现了 mscgen，这对于您的目的应该很方便。

Answer 2

描述协议的标准工具是已被电信行业（和其他行业）使用了数十年的消息序列图。

这是一个非常强大的工具，您当然应该学习和使用。我建议使用http://sourceforge.net/projects/msc-generator/来编辑和生成图表。