@ daybrush/jsdoc (日语) 
npm install --save-dev @daybrush/jsdoc
从0.3.0版本支持打字符
name 财务报告和审定财务报表 type 可以在函数和方法中省略
- 日记
/**
*/
function a(a: Parameter1, b: Parameter2): ReturnType {
}
- 结果
extends 财务报告和审定财务报表 implements 可以在课上省略.
- 日记
/**
*/
export class A extends B implements a {
}
- 结果
支持类型声明
- 日记
/**
* @typedef
*/
export type a<T> = () => T;
- 结果
支持接口声明
- 日记
/**
* @typedef
*/
export interface a {
a: string;
b: number;
c: () => void;
d(a: string, b: number): void;
(a: string, b: number): void;
[key: string]: any;
}
- 结果
兹多克.杰森 (添加 ts 扩展以包括 Pattern)
{
"source": {
"includePattern": ".+\\.(j|t)s(doc|x)?$",
},
}
联署材料文件3
JavaScript 的 API 文档生成器 .
想给JSDoc捐款吗? 请阅读 CONTRIBUTING.md。 。 。 .
安装和使用
JSDoc支持节点.js 4.2.0及后. 您可以在全球安装 JSDoc 或者在您的项目
node_modules 文件夹.
在全球npm上安装最新版本(可能需要) sudo· ; 学会如何修复
这个:
npm install -g jsdoc
在 npm 本地安装最新版本并保存在您的软件包中 package.json 文件 :
npm install --save-dev jsdoc
说明:默认情况下, npm 在版本编号前使用护理操作符添加您的软件包
(例如, ^3.5.2) (中文(简体) ). 我们建议使用瓷砖操作器(例如, ~3.5.2, (中文(简体) ),
它将更新限制在最新的补丁级版本。 见 此堆栈倒流
回复 关于护身符和瓦片的更多信息
操作员.
在本地安装最新开发版本, 不更新您的项目 package.json
文件 :
npm install git+https://github.com/jsdoc3/jsdoc.git
如果您在本地安装了 JSDoc, JSDoc 命令行工具可在 ./node_modules/.bin。 。 。 .
生成文件的文档 yourJavaScriptFile.js数字 :
./node_modules/.bin/jsdoc yourJavaScriptFile.js
或者如果你在全球安装了JSDoc, 只需运行 jsdoc 命令 :
jsdoc yourJavaScriptFile.js
默认情况下,生成的文档会被保存在一个命名的目录中 out您可以使用
--destination (单位:千美元)-d)指定另一个目录的选项.
运行 jsdoc --help 用于完整命令行选项列表.
模板和工具
JSDoc社区创建了许多模板和其他工具,帮助您生成和生成 定制文档。 这里只有几个:
模板
- 贾古阿吉斯多克
- 标签 (单位:千美元)实例(中文(简体) )
- jsdoc3 模板 (单位:千美元)实例(中文(简体) )
- min
- 多克达什 (单位:千美元)实例(中文(简体) )
- 图伊-jsdoc-template (单位:千美元)实例(中文(简体) )
构建工具
其他工具
更多信息
- 文件备查 使用 JSDoc。 。 。 .
- 协助文件 jsdoc3/jsdoc3.github.com (中文(简体) )。 。 。 .
- 加入JSDoc的Slack频道。 。 。 .
- 请求帮助 联合来文文件 用户邮件列表。 。 。 .
- 贴有标签的帖子问题
jsdoc改为 堆栈 过多。 。 。 .
许可证
JSDoc 3是版权 (c) 2011年至今 Michael Mathews 缩略语@gmail.com 编辑 捐款人 联合来文文件。 。 。 .
JSDoc 3是自由软件,根据Apache许可证第2.0版获得许可. 见文件 LICENSE.md
详情请参见此分配表.