javascript - 为什么 jQuery 不使用 JSDoc?

标签 javascript jquery documentation standards jsdoc

<分区>

或者他们只是不在源代码中?我真的很想得到一些东西来阻止 js-doc-toolkit 每次解析 jQuery 时都崩溃。这也意味着我无法正确记录任何使用 jQuery 作为依赖项的代码,除非至少放置一些样板 js-doc block ,这些 block 无法正确记录 jQuery 的结构。有没有我不知道的通用解决方案?顺便说一句,我试过谷歌搜索。

最佳答案

我将在黑暗中试一试,因为我不能代表 jQuery 团队说明为什么不使用 JSDoc。 JSDoc,至少在我上次检查时,没有任何干净的方法来支持方法重载(或参数转换......无论你想在这里给它起什么名字),jQuery 在所有地方都使用它。让我们以 .animate() 为例:

.animate({ height: 5 })
.animate({ height: 5 }, 100)
.animate({ height: 5 }, 100, "linear")
.animate({ height: 5 }, 100, "linear", func)
.animate({ height: 5 }, 100, func)
.animate({ height: 5 }, func)
.animate({ height: 5 }, { duration: 100, queue: false })
.animate({ height: 5 }, { duration: 100, easing: "linear" })
.animate({ height: 5 }, { duration: 100, easing: "linear", complete: func })

所有这些都是有效的,因为 parameter types are checked and shifted as needed尽可能支持任何重载场景……这只会混淆 JSDoc,没有干净的方法可以将这些可选参数添加到文档中。如果这发生了变化,请纠正我,但我最后一次查看(可能是团队最后一次查看)情况仍然如此。

另一个潜在的考虑因素是 jQuery 运行时如何生成一些方法,例如(许多之一),几乎所有的 event handler shortcutsgenerated in a loop其他方法的类似行为......你会如何记录这些? JSDoc 生成在这里真的不能很好地工作。

关于javascript - 为什么 jQuery 不使用 JSDoc?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/4050233/

相关文章:

javascript - JScrollPane 动态高度

javascript - 哪个属性将阻止用户更改输入数据但允许 jQuery 修改?

jquery - HTML拖放声音

javascript - 需要设置 Click & drag column headers 的最小宽度

kotlin - 如何在Intellij中配置Kotlin SDK外部文档?

javascript - Ionic 应用程序 - CordovaPush 不工作

javascript - Bootstrap 表格不工作

jquery - 从 asp.net GridView 中删除寻呼机行的边框

python - 休息 : inline links with arbitrary titles?

javascript - 代码很少或不完整的文档工具