【问题标题】:Is there a detailed documentation on how to create own jsdoc templates?是否有关于如何创建自己的 jsdoc 模板的详细文档?
【发布时间】:2016-09-27 09:23:38
【问题描述】:

短版: 如果我想从头开始开发一个全新的 jsDoc 模板,我需要阅读哪些内容才能了解 jsDoc 的功能、我的模板必须提供什么接口以及我可以使用哪些数据?

加长版: 我已经使用 jsDoc 一段时间了,遇到了一些我想添加的标签和我想从我的文档中生成的概述页面。到目前为止,我用usejsdoc.org 解决了我所有的“用户问题”。我什至设法添加了一个新的 jsdoc 插件来添加一些标签。但是,我找不到关于如何为 jsdoc 创建模板的任何 开发人员文档。我使用ink-docstrap,所以我点击了模板文件夹(publish.js、/tmpl 等)并以某种方式了解了一切是如何工作的。但它非常非常耗时。

要成为 jsDoc 模板专家,我应该阅读什么内容?

【问题讨论】:

    标签: jsdoc jsdoc3


    【解决方案1】:

    These instructions 是我能找到的最接近的:

    创建或使用您自己的模板:

    1. 创建一个与您的模板同名的文件夹(例如,mycooltemplate)。
    2. 在模板文件夹中,创建一个名为publish.js 的文件。此文件必须是导出名为 publish 的方法的 CommonJS 模块。

    例如:

    /** @module publish */
    
    /**
     * Generate documentation output.
     *
     * @param {TAFFY} data - A TaffyDB collection representing
     *                       all the symbols documented in your code.
     * @param {object} opts - An object with options information.
     */
    exports.publish = function(data, opts) {
        // do stuff here to generate your output files
    };
    

    要使用您自己的模板调用 JSDoc 3,请使用 -t 命令行选项,并指定模板文件夹的路径:

    ./jsdoc mycode.js -t /path/to/mycooltemplate
    

    如果做不到,你可以read the source code

    【讨论】:

      【解决方案2】:

      我刚刚发布了我自己的新 jsdoc 主题。我所做的只是简单地复制了默认模板:https://github.com/jsdoc3/jsdoc/tree/master/templates/default,然后进行了处理。

      我还设法添加了具有以下功能的 grunt: * 转编译 + 缩小 js 文件 * 解析sass 样式并缩小它们 * 更改某些内容时刷新文档

      你可以在这里看到它是如何工作的:https://github.com/SoftwareBrothers/better-docs

      【讨论】:

        【解决方案3】:

        您可以自定义现有模板之一(默认、haruki 或静默):

        • 进入node_modules/jsdoc/template 并将它们抓取到node_modules 之外的应用目录中。

        • 随意重命名目录前:jsdoc-template

        • open jsdoc-template 根据需要更新/自定义内容。
          例如:打开publish.js 找到Home 并替换My Js App

        • 通过添加更新jsdoc.json

        "opts": {
          "template": "jsdoc-template"
        }
        

        另一个使用这些模板的选项:jsdoc3 template list examples

        【讨论】:

        • 没错,自定义现有模板可能是最简单的解决方案。但我特意要求“关于如何创建自己的 jsdoc 模板的详细文档”,因为自定义现有模板也需要对 jsdoc 的工作原理有基本的了解,我不想通过阅读源代码来获得这种理解。
        猜你喜欢
        • 1970-01-01
        • 2012-02-15
        • 2015-10-23
        • 1970-01-01
        • 2016-02-08
        • 2019-01-02
        • 2017-01-30
        • 2016-09-04
        • 2020-02-08
        相关资源
        最近更新 更多