JavaScript API 文档工具 JsDoc 3

Apache
JavaScript
跨平台
2009-10-16
红薯

JSDoc 3 是一个根据 Javascript 文件中注释信息,生成 JavaScript 应用、库、模块的 API 文档的工具。你可以使用它记录如:命名空间、类、方法、方法参数等。

JSDoc 3 需要 Node.js 4.2.0 及以上版本。

JSDoc 社区创建了许多模板和其他工具来帮助生成和自定义文档。部分包括:

Templates

Build Tools

Other Tools

的码云指数为
超过 的项目
加载中

评论(0)

暂无评论

暂无资讯

暂无问答

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

背景 Javascript已经成为一门被人们重新认识的编程语言,由于大量JS开源框架的出现,利用Javascript开发的项目越来越多,越来越大。同时,也有越来越多Javascript开发问题暴露出来,如性能、...

2013/08/29 07:41
2.5K
0
使用JSDoc自动生成代码文档

代码要有规范的注释,遵从jsDoc规则来注释可以生成有用的文档。

2017/10/19 20:10
22
0
JS源文件的文档注释与提取

介绍类javadoc的javascript文档注释工具jsdoc和jsdox

2015/04/13 14:39
193
0
TypeScript基础入门之Javascript文件类型检查(三)

转发 TypeScript基础入门之Javascript文件类型检查(三) 继续上篇文章【TypeScript基础入门之Javascript文件类型检查(二)】 支持JSDoc 下面的列表概述了使用JSDoc注释在JavaScript文件中提供类...

2018/10/31 09:48
9
0
TypeScript基础入门之Javascript文件类型检查(一)

转载 TypeScript基础入门之Javascript文件类型检查(一) TypeScript 2.3及更高版本支持使用--checkJs在.js文件中进行类型检查和报告错误。 您可以通过添加//@ts-nocheck注释来跳过检查某些文件...

2018/10/26 22:08
14
0
TypeScript基础入门之Javascript文件类型检查(二)

转发 TypeScript基础入门之Javascript文件类型检查(二) 继续上篇文章【TypeScript基础入门之Javascript文件类型检查(一)】 对象文字是开放式的 在.ts文件中,初始化变量声明的对象文字将其类...

2018/10/30 10:39
11
0
使用jsdoc-toolkit来自动生成js api文档

一、 环境搭建 1) 首先要安装java环境,如果不太了解的参看:http://jingyan.baidu.com/article/e75aca85b29c3b142edac6a8.html 2) 安装jsdoc-toolkit 下载地址:http://code.google.com/p/...

2018/10/27 12:31
26
0
Dgeni - 文档生成器

Dgeni - Documentation Generator https://github.com/angular/dgeni

2015/10/26 17:09
220
0
注释那些事儿:前端代码质量系列文章(一)

摘要: 好的注释可以提高代码的可读性和可维护性,从而提高代码质量。那么什么是好的注释?如何写出好的注释? “Comment or not comment, that is the question” 好的注释可以提高代码的可...

2018/04/27 16:20
25
0

没有更多内容

加载失败,请刷新页面

返回顶部
顶部