配置JSDoc的默认模板¶

JSDoc的默认模板提供了几个选项, 您可以使用这些选项来自定义生成的文档的外观和内容.

To use these options, you must 使用配置文件配置JSDoc for JSDoc and set the appropriate options in the configuration file.

Generating pretty-printed source files¶

默认情况下, JSDoc的默认模板会生成源文件的精美打印版本. 它还链接到文档中这些漂亮的打印文件.

要禁用漂亮打印的文件, 请将选项 templates.default.outputSourceFiles 设置为 false. 使用此选项还会从文档中删除指向源文件的链接. JSDoc 3.3.0及更高版本中提供了此选项.

将静态文件复制到输出目录¶

JSDoc的默认模板自动将一些静态文件(如CSS样式表)复制到输出目录. 在JSDoc 3.3.0及更高版本中, 您可以告诉默认模板将其他静态文件复制到输出目录. 例如, 您可能希望将图像目录复制到输出目录, 以便在文档中显示这些图像.

要将其他静态文件复制到输出目录, 请使用以下选项:

templates.default.staticFiles.include: 一组路径, 其内容应复制到输出目录. 子目录也将被复制.
templates.default.staticFiles.exclude: 应该不复制到输出目录的路径数组.
templates.default.staticFiles.includePattern: 一个正则表达式, 指示要复制的文件. 如果未定义此属性, 则将复制所有文件.
templates.default.staticFiles.excludePattern: 一个正则表达式, 指示要跳过的文件. 如果未定义此属性, 则不会跳过任何内容.

要将 ./myproject/static 中的所有静态文件复制到输出目录:

Copying a directory of images to the output directory¶

{
  "templates": {
    "default": {
      "staticFiles": {
        "include": [
            "./myproject/static"
        ]
      }
    }
  }
}

如果你的静态文件目录包含文件 ./myproject/static/img/screen.png, 你可以使用HTML标签 <img src="img/screen.png"> 在你的文档中显示图像..

覆盖默认模板的布局文件¶

默认模板使用名为 layout.tmpl 的文件为生成的文档中的每个页面指定页眉和页脚. 特别是, 此文件定义为每个页面加载哪些CSS和JavaScript文件. 在JSDoc 3.3.0及更高版本中, 您可以指定自己的 layout.tmpl 文件来使用, 除了标准文件之外, 您还可以加载自己的自定义CSS和JavaScript文件.

要使用此功能, 请将选项 templates.default.layoutFile 设置为自定义布局文件的路径. 根据当前工作目录解析相对路径;配置文件的路径;和JSDoc目录, 按此顺序.

配置JSDoc的默认模板¶

Generating pretty-printed source files¶

将静态文件复制到输出目录¶

在页脚中显示当前日期¶

在导航栏中显示长名¶

覆盖默认模板的布局文件¶