JSDoc 可以在基于文本的格式,如HTML,XML,JSON等广泛的生产数量的文档。
JSDoc以前所知道的JsDoc工具包。
使用的Java解析的源代码,抽取注释并生成文档前者JSDoc版本。由于3.x的分支Node.js的来代替。
此外Node.js的,JSDoc也可以与Mozilla的Rhino引擎正常工作。
要正确使用JSDoc,检查其文档,了解有关如何格式化你的源代码注释的信息,使他们能够检测和使用JSDoc的引擎。
什么是新的在此版本中:
- 在现在可以Node.js的运行JSDoc
- 现在,可以使用@interface和@implements标签记录的接口及其实现。
- 关闭编译器的@inheritDoc和@覆盖标签现在支持。
- 如果在JSDoc注释符号包括@mixes标签,所有的混入现在出现在符号的文档。
- JSDoc因为它运行现在可以将信息记录到控制台(例如,每个JSDoc解析文件的名称)。要记录这些信息,用--verbose标志运行JSDoc。
- 现在,可以使用任何文件作为包或自述文件为您的文档。使用-P / - 封装/和-R / - 自述标志来指定包和README文件
- 在默认模板的排版和配色方案已显著的改善。
什么3.3.2版本新:
- 在现在可以node.js中<运行JSDoc / LI>
- 现在,可以使用@interface和@implements标签记录的接口及其实现。
- 关闭编译器的@inheritDoc和@覆盖标签现在支持。
- 如果在JSDoc注释符号包括@mixes标签,所有的混入现在出现在符号的文档。
- JSDoc因为它运行现在可以将信息记录到控制台(例如,每个JSDoc解析文件的名称)。要记录这些信息,用--verbose标志运行JSDoc。
- 现在,可以使用任何文件作为包或自述文件为您的文档。使用-P / - 封装/和-R / - 自述标志来指定包和README文件
- 在默认模板的排版和配色方案已显著的改善。
什么在3.3.0版本新:
- 在现在可以node.js中<运行JSDoc / LI>
- 现在,可以使用@interface和@implements标签记录的接口及其实现。
- 关闭编译器的@inheritDoc和@覆盖标签现在支持。
- 如果在JSDoc注释符号包括@mixes标签,所有的混入现在出现在符号的文档。
- JSDoc因为它运行现在可以将信息记录到控制台(例如,每个JSDoc解析文件的名称)。要记录这些信息,用--verbose标志运行JSDoc。
- 现在,可以使用任何文件作为包或自述文件为您的文档。使用-P / - 封装/和-R / - 自述标志来指定包和README文件
- 在默认模板的排版和配色方案已显著的改善。
什么是新的版本3.2.2 / 3.3.0-β1:
- 在解决了一个回归JSDoc 3.2.1,可以防止一个函数声明从阴影具有相同名称的声明外部范围中。
- 如果一个子类覆盖父类的方法,而不记录重写的方法,该方法的文档现已从父类被复制。
- 您现在可以使用内嵌HTML标签降价格式的文本。此外,JSDoc现在只使用了明显的降价解析器;降价-JS解析已被删除。
- 类型的表达式,现在包括更广泛的范围内可重复的类型。此外,您现在可以使用关闭编译器的可空和非可空修饰符重复的类型。例如,该类型表达式...!串(一个重复的,不可为空字符串)现在解析正确。
什么是2.4.0版本,新的:
- 在该添加多发的符号具有相同名称的固定的臭虫到文档。
- 添加了对-m选项来禁止对多个文档警告。
- 添加补丁通过brownsea42支持命令行上引用用户变量。
- 修正了一个有时会导致链接事件的错误是不正确的。
要求:
- 在客户端中启用JavaScript
- 在Node.js的0.10或更高
评论没有发现