| 12345678910111213141516171819202122232425262728293031323334353637383940414243 |
- {
- //控制那些标签允许被使用和解析
- "tags": {
- "allowUnknownTags": true,
- "dictionaries": ["jsdoc"] // 指定所用词典
- },
-
- //指定要用jsdoc生成文档的文件
- "source": {
- "include": ["src/jtMap3d"], //路径组成的数组，jsdoc将为它们生成文档
- "includePattern": ".+\\.js(doc|x)?$", //正则表达式字符串，只有文件名匹配的文件才会被jsdoc扫描。默认为 .+.js(doc)?$ 即 .js 或 .jsdoc 结尾的文件才会被扫描
- "exclude": ["./src/main.js"], //路径组成的数组，jsdoc应忽略的路径
- "excludePattern": "(^|\\/|\\\\)_" //正则表达式字符串，文件名匹配的文件将被jsdoc忽略。默认为 (^|\\/|\\\\)_ 即下划线开头的文件或下划线开头的目录下的所有文件
- },
-
- //要启用的插件，在数组中添加插件相对于JSDoc文件夹的路径即可
- "plugins": ["plugins/markdown"],
- "opts": { //配置命令行选项，与上面讲的选项相对应
- "destination": "./jsDoc/", //文档输出目录
- "encoding": "utf8", //读取文件的编码
- "private": true,
- "recurse": true, // 运行时是否递归子目录
- "verbose": false, //运行时是否输出详细信息
- "template": "./node_modules/tui-jsdoc-template" //使用模板tui-jsdoc-template
- },
-
- //配置jsdoc所生成的文档的模板
- "templates": {
- "cleverLinks": true,
- "monospaceLinks": true,
- "useLongnameInNav": true,
- "showInheritedInNav": true,
- "default": {
- "outputSourceFiles": false //关闭源文件
- },
- "name": "jt3dSDK 开发文档（v1.0）", //tui-jsdoc-template模板，logo标题
- "footerText": "金田产业发展(山东)集团有限公司", //tui-jsdoc-template模板，底端标题
- "logo": {
- "width": "32px", //tui-jsdoc-template模板，logo图片，宽度
- "height": "32px" //tui-jsdoc-template模板，logo图片，高度度
- }
- }
- }
|
