grunt-jsdoc

使用grunt-jsdoc自动化生成javascirpt文档

若如初见. 提交于 2019-12-22 20:48:34
【推荐】2019 Java 开发者跳槽指南.pdf(吐血整理) >>> 背景 Javascript已经成为一门被人们重新认识的编程语言,由于大量JS开源框架的出现,利用Javascript开发的项目越来越多,越来越大。同时,也有越来越多Javascript开发问题暴露出来,如性能、网页加载速度等,其中,Javascript文档维护也成为了开发者亟待解决的一个难题。 许多现代编程语言都有自己的集成化文档生成工具,像Java有JavaDoc,.NET有NDoc,PHP有PHPDoc,这些自动化文档工具可以根据代码中的注释自动生成代码文档。 NOTE: 我个人使用的是LINUX,所以本文很多命令都是在LINUX下运作的。 依赖 JsDoc 实际上, JsDoc 是一门用于标注Javascript源代码的语言。使用包含JsDoc定义的注解,程序员可以在Javascript注释中包含API文档。通过一系列工具进行批量处理,最终生成HTML或者Rich Text Format等格式的API文档。 目前 JsDoc最新版本 是3.0。 JsDoc Toolkit JsDoc Toolkit 是一个自动化文档工具,它是发布在Google code上的一个开源项目,和其他语言的文档工具一样,它可以自动从Javascript代码中提取注释生成格式化文档。 因为JsDoc