如何编写协议文档

Question

我正在为我的游戏编写协议，我不确定使用哪种软件。

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

有没有可以帮助我的好的做法或工具？

Answer 1

描述协议的标准工具是message sequence chart，电信行业（和其他人）已经使用了几十年。

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

Answer 2

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

Doxygen还实现了mscgen，这对你的目的来说应该很方便。