VSDoc是一种很棒的注释Javascript的方式,我特别喜欢使一个Javascript文件“依赖”另一个Javascript文件的功能。这为考虑到脚本包含的正确顺序的Java压缩器/合并器铺平了道路。
唯一可能困扰您的是VS-Doc。
是否有任何与供应商无关的竞争格式?
非Microsoft IDE(例如Eclipse等)使用的VSDoc标准有多广泛?
最佳答案
最常用的标准是jsdoc-toolkit实施的JsDoc。语法简短明了,易于解析。
有许多工具可以从中生成文档,例如ext-doc,并且大多数IDE都对此提供了内置支持。
它没有任何用于注释依赖项的语句,但是与任何文档注释相比,这实际上是一个小问题而不是文档问题,因为任何注释都可以包括依赖项列表。