从Node.js运行基本的JSDoc编译/渲染之后：
jsdoc file1.js file2.js
我使用目录“out”中的默认模板获得格式良好的文档.几乎所有都如预期！
但是在打开文档时,它总是在index.html页面上显示“Home”,在该初始页面上没有内容,并且在侧边栏导航中有“Home”.
我如何以及在何处注明项目名称以取代“Home”？我还想看一个项目描述,以及作者和版权信息.
这似乎是JSDoc中最基本的事情,但我无法找到这些信息！基于我在互联网上发现的一些随机文章,我尝试了以下内容：
/**
* This JavaScript file contains foo bar baz...
*
* @projectname Project Name
* @version 0.1
* @author Greg Pettit
* @copyright 2015
*
*/
但我没有爱.
[编辑添加：]
发现了@file / @fileOverview / @overview(所有同义词)指令,这有点帮助,因为我现在可以为每个文件描述和设置版权/作者信息：
/**
* @file Project description which renders below the individual filename and therefore isn't a real overview blurb.
*
* @version 0.1
* @author Greg Pettit
* @copyright 2015
*
*/
这留下了两个“问题”来解决：
>概述说明;我认为@file可以满足我的大多数需求,但由于它是每个文件,我仍然会喜欢在包含文件的描述之前出现的“简介”类型段落或概述段落.
>用自定义文本替换“主页”文本
解决方法:
生成主页
创建markdown文件README.md
生成jsdoc：
$jsdoc path/to/js path/to/readme/README.md
欲了解更多关于此次访问的信息official documentation
更改“主页”文字
我不认为这是一种正确的方法,但这是有效的.
如果在工作目录中的项目查找模板文件中安装了jsdoc,我的是：
./node_modules/jsdoc/templates/default/publish.js
然后使用搜索命令搜索“Home”并替换为您的文本,下一步是在生成jsdoc时指定模板：
$jsdoc ./src/scripts/ ./README.md -t node_modules/jsdoc/templates/default/
标签：javascript,jsdoc,jsdoc3 来源： https://codeday.me/bug/20191007/1868443.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。