如何记录 Web 错误
MDN Web 文档上的 JavaScript 错误参考 是一个帮助 Web 开发人员解决在 开发者控制台 中出现的错误的项目。为了这个项目,我们需要在 MDN Web 文档上编写更多错误文档,以便我们可以向消息被抛出的工具添加更多链接。本文介绍了如何记录 Web 错误。
JavaScript 错误包含一个“了解更多”链接,该链接会带您到 JavaScript 错误参考中,其中包含有关修复问题的更多建议。要记录 Web 错误,您需要了解或能够深入研究一些 JavaScript。
步骤 1 - 确定要记录的错误
步骤 2 - 检查现有的错误文档
- 查看现有的 JavaScript 错误参考 并了解错误的记录方式。
- 根据您要编写的错误类型,您可以仔细查看这些页面。
- 您可能想复制现有页面的内容来启动新页面。
步骤 3 - 创建新的错误页面
- 所有错误页面都位于此树下:/docs/Web/JavaScript/Reference/Errors
- 要创建新页面,请参阅我们 如何创建页面 指南中的说明。
步骤 4 - 记录错误
- 您可以使用现有错误文档中复制的结构,也可以从头开始。由您选择!
- 您至少应该有
- 一个包含在不同浏览器中抛出的消息的语法框。
- 错误类型。
- 解释为什么发生此错误及其后果的文本。超越抛出的消息。
- 展示错误的示例(可能不止一个!)以及一个展示如何修复代码的示例。
- 指向 MDN Web 文档上其他参考材料的指针。
步骤 5 - 获取内容审核
创建错误页面后,将其作为拉取请求提交。我们的审核团队成员将被自动分配来审核您的页面。