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