如何編寫協議文檔

Question

我正在爲我的遊戲編寫一個協議，我不確定要使用哪種軟件。

我一直在嘗試在Microsoft Word和Excel中編寫它，但它並不總是很容易閱讀或編輯它。

有什麼好的做法或工具可以幫助我嗎？

Answer 1

用於描述協議的標準工具是message sequence chart，幾十年來電信行業（及其他）已經使用該工具。

這是一個非常強大的工具，你肯定應該學習和使用。我建議使用http://sourceforge.net/projects/msc-generator/來編輯和生成圖表。

Answer 2

您可以使用doxygen。您可以在源代碼的某處實現協議文檔，也可以創建獨立文件。 Doxygen常用於源文檔，但也應該適用於此。

Doxygen也實施mscgen，這應該成爲你的目的。