在DOM中记录或绘制自定义事件模型的正确方法

Question

想象一下，您的Web应用程序中有许多组件和子组件。您希望跟踪添加的所有自定义事件的行为方式。是否有既定的方法来绘制或记录这些行为？

以下是文档应显示的一些内容：

1. 各种组件的相关DOM元素的实际嵌套。
2. 事件的名称及其被解雇的地点。
3. 附加到自定义事件的所有有效负载（例如，原型自定义事件中memo的内容。）
4. 观察事件的地方。
5. 指示响应其他事件而触发的事件。
6. 允许事件冒泡，以及停止事件的地方。

Answer 1

我从来没有听说过Web应用程序前端的既定文档标准。

也就是说，由于您已经确定了要跟踪的应用程序的不同方面，因此可以将此信息保存在每个事件处理程序的docblock中，并使用jsdoc toolkit生成一些内联文档。

恕我直言，我认为既然你已经知道你想要记录的是什么，你应该随意创建任何对你最有意义的格式的文档，即使它对你的应用程序/组织来说是完全独特的。 stackoverflow上8小时没有答案必须意味着没有标准答案;）

Answer 2

老实说我以前喜欢视觉建模师，当MS把它转移到Visio时我有点失望。

也就是说，Visio仍然是一个很棒的工具，你可以用它来创建组件的对象模型，定义事件，属性，方法等。它有一些UML设计的内置功能。<​​/ p>

但我最后要说的是，我通常会以记事本或MS字结尾。 根据你想要的文档的详细程度，键入组件的注释或描述永远不能很好地适用于任何类型的DOM工具，但你可以像Word文档中的疯子一样加粗，制表，列表和斜体。

听起来很难过，但这是真的！