【问题标题】:JSDoc: How to add functions to Nav BarJSDoc:如何向导航栏添加功能
【发布时间】:2016-07-28 00:43:26
【问题描述】:

在jsdoc默认模板中,导航栏是在publish.jsbuildNav函数中构造的。

例如

nav += buildMemberNav(members.events, 'Events', seen, linkto);

但是,没有members.functions

我想知道如何在导航栏中列出所有函数(在每个命名空间、类下)。

【问题讨论】:

    标签: jsdoc jsdoc3


    【解决方案1】:

    我找到了一个模板 https://github.com/nijikokun/minami/blob/master/publish.js#L298-L333 ,他们在其中为每个类创建了一个子方法列表,作为参考。

    比方说,如果我们想在导航栏中列出每个命名空间下的所有函数,我们可以有下面的代码来添加相关的html

    var methods = find({kind:'function', memberof: item.longname}); 
    

    item 在我们的例子中是member.namespace

    if (methods.length) {
        itemsNav += "<ul class='methods'>";
        methods.forEach(function (method) {
            itemsNav += "<li data-type='method'>";
            itemsNav += linkto(method.longname, method.name);
            itemsNav += "</li>";
        });
        itemsNav += "</ul>";
    }
    

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2022-11-11
      • 2016-12-25
      • 2022-01-04
      • 2021-04-09
      相关资源
      最近更新 更多