TypeScript 改进内置类型声明的文档

vmjh9lq9  于 6个月前  发布在  TypeScript
关注(0)|答案(1)|浏览(44)

lib.dom.d.ts为例,我注意到文档并不是它应有的样子。关于改进这一点有什么政策吗?我认为更好的文档的好处是显而易见的,例如添加示例或说明某些功能在浏览器中的支持情况。

然而,我想知道:

  • 由于文件已经相当大了,而且添加文档可能会让它膨胀100倍,这是否会导致任何性能问题(在编辑器中)?如果是这样的话,有没有办法解决这个问题?
  • 关于这些事情的最佳文档(据我所知),都在MDN上。一个很好的开始可能是链接/自动添加一些来自那里的文档,如果许可允许的话(https://wiki.developer.mozilla.org/en-US/docs/MDN/About#Copyrights_and_licenses)。我认为它至少在一定程度上是这样。
csga3l58

csga3l581#

我们为非DOM内容做了这个(这更容易定位),效果很好。文件大小不是一个大问题,因为扫描评论很快,而且只做一次。

相关问题