jsdoc-docs
入门
JSDoc 3入门
在JSDoc 3中使用namepath
JSDoc的命令行参数
使用配置文件配置JSDoc
配置JSDoc的默认模板
块和内联标签
关于JSDoc插件
markdown插件
教程
引入包文件
引入README文件
License
标签
JSDoc示例
Contribute
待办清单
jsdoc-docs
Docs
»
入门
View page source
入门
¶
JSDoc 3入门
在代码中添加文档注释
生成一个网站
在JSDoc 3中使用namepath
JSDoc 3中的Namepaths
JSDoc的命令行参数
示例
使用配置文件配置JSDoc
配置文件格式
默认配置选项
配置插件
指定递归深度
指定输入文件
指定源类型
将命令行选项合并到配置文件中
配置标签和标签词典
配置模板
配置JSDoc的默认模板
Generating pretty-printed source files
将静态文件复制到输出目录
在页脚中显示当前日期
在导航栏中显示长名
覆盖默认模板的布局文件
块和内联标签
概述
示例
关于JSDoc插件
创建和启用插件
关于JSDoc插件
报告错误
markdown插件
启用Markdown插件
在其他JSDoc标记中转换Markdown
从Markdown处理中排除默认标记
在换行符处硬包装文本
将ID属性添加到标题中
教程
添加教程
配置标题, 顺序和层次结构
链接API文档中的教程
引入包文件
示例
引入README文件
示例
License