VSDoc 的替代品?

发布于 2024-09-04 17:09:00 字数 239 浏览 10 评论 0原文

VSDoc 是一种很棒的注释 Javascript 的方式,我特别喜欢使一个 Javascript 文件“依赖”另一个文件的能力。这为考虑脚本包含的正确顺序的 Javascript 压缩器/组合器铺平了道路。

唯一可能让一些人烦恼的是它是VS-Doc。

是否存在供应商中立的竞争格式?

VSDoc 标准被非 Microsoft IDE(例如 Eclipse 等)使用的范围有多广?

VSDoc is an awesome way of commenting Javascript, and I particularly like the ability to make one Javascript file 'depend' on another. This paves the way for Javascript minifiers/combiners that take into account proper ordering of script includes.

The only thing that might bother some is that it's VS-Doc.

Are there any competing formats that are vendor-neutral?

And how widely is the VSDoc standard used by non-Microsoft IDEs such as Eclipse, etc?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

三五鸿雁 2024-09-11 17:09:00

最常用的标准是 JsDoc,由 jsdoc-toolkit 实现。语法简短,易于解析。

有许多工具可以从中生成文档,例如ext-doc,大多数 IDE 都内置了对此的支持。

它没有任何用于注释依赖项的语句,但这实际上更像是一个缩小器问题,而不是文档问题,因为任何注释都可以包含依赖项列表。

The standard that is used the most is JsDoc, as implemented by jsdoc-toolkit. The syntax is short and concise, and is easy to parse.

There are many tools that can generate documentation from these, such as ext-doc, and most IDE's have built in support for this.

This does not have any statements for annotating dependencies, but this is really more a minifier issue than a documentation issue as any comment can include the list of dependencies.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文