在 DOM 中记录或绘制自定义事件模型的正确方法
想象一下您的 Web 应用程序中有一堆组件和子组件。 您想要跟踪您添加的所有自定义事件的行为方式。 是否有既定的方法来绘制或记录这些行为？
以下是文档应显示的一些内容：
- 各个组件的相关 DOM 元素的实际嵌套。
- 事件的名称以及他们被解雇的地点。
- 附加到自定义事件的任何有效负载（例如，Prototype 自定义事件中的
memo内容。） - 观察事件的位置。
- 指示为了响应其他事件而触发哪些事件。
- 哪里允许事件冒泡，哪里就停止事件。
Imagine you have a bunch of components and subcomponents in your web application. You want to keep track of how all the custom events you added behave. Are there established ways to diagram or document these behaviors?
Here are some things the documentation should show:
- The actual nesting of relevant DOM elements of the various components.
- The names of events and where they're fired from.
- Any payloads that are attached to the custom events (e.g. the contents of
memoin a Prototype custom event.) - The places where events are observed.
- Indications of what events are fired in response to other events.
- Where events are allowed to bubble, and where they are stopped.
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（2）
我从未听说过 Web 应用程序前端的既定文档标准。
也就是说，由于您已经确定了要跟踪的应用程序的不同方面，因此您可以将此信息保留在每个事件处理程序的文档块中，并使用 jsdoc 工具包 用于生成一些内联文档。
恕我直言，我认为既然您已经知道要记录的内容，那么您应该随意以对您最有意义的任何格式创建文档，即使它对于您的应用程序/组织来说是完全独特的。 在 stackoverflow 上呆了 8 个小时却没有答案，就意味着没有标准答案；）
I've never heard of an established documentation standard for web application front-ends.
That said, since you've identified the different aspects of your application that you want to track, you could keep this info in a docblock for each event handler, and use the jsdoc toolkit to generate some inline docs.
IMHO, I think that since you know what it is that you want to document already, you should feel free to create documentation in whatever format makes the most sense for you, even if its completely unique to your app/organization. 8 hours on stackoverflow with no answers must mean there is no standard answer ;)
老实说，我曾经很喜欢视觉建模器，当 MS 将它转而使用 Visio 时，我有点失望。
也就是说，Visio 仍然是一个很棒的工具，您可以使用它来创建组件的对象模型并定义事件、属性、方法等。它具有一些用于 UML 设计等的内置功能。
但最后我不得不说，我通常会用记事本或MS Word结束。
根据您希望文档的详细程度，为组件输入注释或描述永远不会真正适合任何类型的 DOM 工具，但您可以像 Word 文档中的疯子一样加粗、制表符、列表和斜体。
听起来很悲伤，但这是事实！
Honestly I used to LOVE visual modeler, and when MS dumped it for Visio I was somewhat disappointed.
That said, Visio is still a great tool, and you can use it for creating object models of components and defining events, properties, methods etc. It has some built in functionality for UML designs and all.
But I have to say in the end, I usually end up with notepad or MS word.
Depending on how verbose you want to be with your documentation, typing up notes or a description for a component never really fits nicely into any kind of DOM tool, but you can bold, tab, list and italicize like a madman inside a Word doc.
Sounds sad, but it's true!