想象一下,您的 Web 应用程序中有一堆组件和子组件。您想要跟踪您添加的所有自定义事件的行为方式。是否有既定的方法来绘制或记录这些行为?
以下是文档应显示的一些内容:
- 各种组件的相关 DOM 元素的实际嵌套。
- 事件的名称以及它们被触发的位置。
- 附加到自定义事件的任何有效负载(例如,
memo
原型自定义事件中的内容。) - 观察事件的地方。
- 指示哪些事件被触发以响应其他事件。
- 允许事件在哪里冒泡,在哪里停止。
想象一下,您的 Web 应用程序中有一堆组件和子组件。您想要跟踪您添加的所有自定义事件的行为方式。是否有既定的方法来绘制或记录这些行为?
以下是文档应显示的一些内容:
memo
原型自定义事件中的内容。)我从未听说过针对 Web 应用程序前端的既定文档标准。
也就是说,由于您已经确定了要跟踪的应用程序的不同方面,您可以将此信息保存在每个事件处理程序的 docblock 中,并使用jsdoc 工具包生成一些内联文档。
恕我直言,我认为既然您已经知道要记录什么,您应该随意以对您最有意义的任何格式创建文档,即使它对于您的应用程序/组织来说完全是独一无二的。在 stackoverflow 上 8 小时没有答案一定意味着没有标准答案;)
老实说,我曾经很喜欢视觉建模器,当 MS 将它转给 Visio 时,我有点失望。
也就是说,Visio 仍然是一个很棒的工具,您可以使用它来创建组件的对象模型并定义事件、属性、方法等。它具有一些用于 UML 设计等的内置功能。
但最后我不得不说,我通常以记事本或 MS word 结尾。根据您希望文档的详细程度,输入注释或组件描述永远不会真正适合任何类型的 DOM 工具,但您可以像 Word 文档中的疯子一样加粗、制表符、列出和斜体。
听起来很悲伤,但这是真的!