我对 akka/actor 系统很陌生,并尝试理解同事编写的代码。
这样做,我问自己什么样的文档有助于更快地理解实施的“演员系统”。
据我所知,您需要至少了解系统的两个不同视角才能理解它。
- 首先是静态的“创作层次”,主要定义演员之间的父子关系。
- 第二个是动态的“消息/事件流”,主要定义参与者之间交换的消息。作为一种特殊情况,它还包括已实现的有限状态机。
所以,我想知道是否有关于如何记录参与者系统的常见最佳实践:
- 应该记录什么样的观点?
- 是否有关于如何构建代码的推荐方法(例如将父子关系反映为包结构)?
- 命名约定?
- 能够解析代码并提供一些文档的工具?
- ...