JSDoc：如何向导航栏添加功能

Question

在 jsdoc 默认模板中，导航栏是在 publish.js buildNav 函数中构造的。

例如

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

然而，没有members.functions。

我想知道如何在导航栏中列出所有功能（在每个命名空间下，class）。

Answer 1

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

比如说，如果我们想在导航栏中列出每个命名空间下的所有函数，我们可以有以下代码来添加相关的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>";
}

JSDoc：如何向导航栏添加功能

JSDoc: How to add functions to Nav Bar

jsdoc

jsdoc3