Warning: file_get_contents(/data/phpspider/zhask/data//catemap/8/lua/3.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Javascript 如何使指向索引页的链接显示_Javascript_Jsdoc_Jsdoc3 - Fatal编程技术网

Javascript 如何使指向索引页的链接显示

Javascript 如何使指向索引页的链接显示,javascript,jsdoc,jsdoc3,Javascript,Jsdoc,Jsdoc3,我已经开始将jsdoc与jaguarjs jsdoc一起使用,以便使用node为我的API生成文档。它工作得很好,我甚至可以使用readme.md文件来生成索引页,但我似乎无法将指向索引页的链接显示在搜索栏上方的左上角 我正在运行的命令如下所示。 $./node_modules/.bin/jsdoc./README.md./app/-r-t./node_modules/jaguarjs jsdoc/-d docs 到目前为止,我在api中使用的唯一标记是@namespace、@functio

我已经开始将jsdoc与jaguarjs jsdoc一起使用,以便使用node为我的API生成文档。它工作得很好,我甚至可以使用readme.md文件来生成索引页,但我似乎无法将指向索引页的链接显示在搜索栏上方的左上角

我正在运行的命令如下所示。

$./node_modules/.bin/jsdoc./README.md./app/-r-t./node_modules/jaguarjs jsdoc/-d docs
到目前为止,我在api中使用的唯一标记是@namespace、@function和@member。正如我所说,他们似乎正在产生良好的。链接只是一件小事,但它让我很恼火


有什么想法吗?

这可能不是唯一的办法,但我确实找到了解决办法。您可以在generate命令中包含配置

jsdoc -t `path to template` -c `path to config` `files to include`
在该模板中,可以提供应用程序名称

}
  "templates": {
    "applicationName": "The Name",
    ...more configs
  },
  ...more configs
}

该名称将出现在右上角的索引页链接中。链接本身总是生成的,但如果它是空的,就没有多大用处。

这可能不是唯一的方法,但我确实找到了解决方案。您可以在generate命令中包含配置

jsdoc -t `path to template` -c `path to config` `files to include`
在该模板中,可以提供应用程序名称

}
  "templates": {
    "applicationName": "The Name",
    ...more configs
  },
  ...more configs
}
该名称将出现在右上角的索引页链接中。链接本身总是生成的,但如果它是空的,就没有多大用处。

此外,jsdoc(v3.4.0)和jaguarjs jsdoc(v0.0.1)都是使用npmalso在本地安装的,jsdoc(v3.4.0)和JaguarJSdoc(v0.0.1)都是使用npm在本地安装的