Question

从Node.js运行基本的JSDoc编译/渲染后：

   public static double codificarCredenciaisAcesso(String[][] tabelaProbs, String palavra) {
    double  aux = 0;
    String letra, palavraAux = "";
    int indice = 0;

    double[] probabilidadesAux = new double[tabelaProbs[1].length + 2];
    probabilidadesAux[0] = 0;
    for (int i = 0; i < tabelaProbs[1].length; i++) {
        aux += Double.parseDouble(tabelaProbs[1][i].trim());
        probabilidadesAux[i + 1] = aux;
    }
    probabilidadesAux[probabilidadesAux.length - 1] = 1;


    for (int indiceLetra = 0; indiceLetra < palavra.length(); indiceLetra++) {
        letra = palavra.charAt(indiceLetra) + "";
        palavraAux += letra;


        for (int iProb = 0; iProb < tabelaProbs[0].length; iProb++) {
            if (letra.equalsIgnoreCase(tabelaProbs[0][iProb])) {
                indice = iProb;
                break;
            }
        }

        double intervaloProb = probabilidadesAux[indice + 1] - probabilidadesAux[indice];
        for (int i = 0; i < probabilidadesAux.length; i++) {
            if (indice == i) {
                probabilidadesAux[0] = probabilidadesAux[indice];
                probabilidadesAux[probabilidadesAux.length - 1] = probabilidadesAux[indice + 1];
                aux = probabilidadesAux[0];
                for (int j = 1; j < probabilidadesAux.length - 1; j++) {
                    double probabilidadeX = Double.parseDouble(tabelaProbs[1][j - 1]);
                    probabilidadesAux[j] = aux + (probabilidadeX * intervaloProb);
                    aux = probabilidadesAux[j];
                }
                break;
            }
        }
    }
    double credencialCodificada = probabilidadesAux[indice];

    return credencialCodificada;
}

我使用目录“out”中的默认模板获得格式良好的文档。几乎所有都是预期的！

但是在打开文档时，它总是在index.html页面上显示“Home”，在该初始页面上没有内容，并且在侧边栏导航中有“Home”。

我如何以及在何处注明项目名称以取代“Home”？我还想看一个项目描述，以及作者和版权信息。

这似乎是JSDoc中最基本的事情，但我无法找到这些信息！基于我在互联网上发现的一篇随机文章，我尝试了以下内容：

jsdoc file1.js file2.js

但我没有爱。

[编辑添加：]

发现了@file / @fileOverview / @overview（所有同义词）指令，这有点帮助，因为我现在可以为每个文件描述和设置版权/作者信息：

/** 
 * This JavaScript file contains foo bar baz...
 * 
 * @projectname Project Name
 * @version 0.1
 * @author Greg Pettit
 * @copyright 2015
 * 
 */

还有2个“问题”需要解决：

概述说明;我认为@file可以满足我的大多数需求，但由于它是每个文件，我仍然希望在包含文件的描述之前出现一个“介绍”类型段落或概述段落。
用自定义文字替换“主页”文字

Answer 1

生成主页

创建降价文件README.md

生成jsdoc：

$ jsdoc path/to/js path/to/readme/README.md

要详细了解此次访问official documentation

更改“主页”文字

我不认为这是一种正确的方法，但这有效。

如果您在工作目录中的项目查找模板文件中安装了jsdoc，那么我的是：

./node_modules/jsdoc/templates/default/publish.js

然后使用搜索命令搜索“Home”并替换为您的文本，下一步是在生成jsdoc时指定模板：

 $ jsdoc ./src/scripts/ ./README.md -t node_modules/jsdoc/templates/default/

Answer 2

我无法发表评论所以我会在这里添加一个注释，以便根据“\ n \ n \ n \ n \ n \ n \ n \ n \ n \ node \ node_modules中找到的文件中的说明，明确如何在不更改默认模板的情况下完成原始问题中的所有操作\ jsdoc \ templates“文件夹，解释了如何创建自己的模板。将生成的js文档中的“Home”标题更改为项目特定标题（例如“MyDescription”）并在主页顶部包含概述blurb的步骤概述如下。

步骤

首先，要将总体概述放在js文档主页的顶部，您可以根据上面的答案和链接制作一个名为README.md的简单文本文件，该文件写在Markdown中。如果该文件的路径包含在命令行中，如上所示，或者在名为conf.json的文件中添加了引用，则整个文本将显示在页面顶部，在这种情况下，您可以使用jsdoc -c pathTo\conf.json命令行（参见下面第4项中的示例）。（正如链接所解释的那样，你可以创建一个包含任何名称或扩展名的文件，只要它在Markdown中，你告诉jsdoc在哪里找到它。）
将默认模板（\npm\node_modules\jsdoc\templates\default）的文件夹和内容复制到新目录，将新文件夹重命名为myTemplate。
使用上面的建议更改'主页'文本，搜索新publish.js文件夹中名为myTemplate的文件，并将“Home”替换为“MyDescription”。这里需要注意两点：文件名必须保留publish.js，而“Home”出现在原始“publish.js”的两个位置，行
```
var nav = '<h2><a href="index.html">Home</a></h2>';
```
和开始的行{{1 }}。
告诉jsdoc生成器在哪里找到自定义模板（generate('Home',...文件夹）和概述文件（“README.md”）。您可以将myTemplate添加到命令行，或者如果在文本编辑器中创建名为-t pathTo\myTemplate的文件，则可以使用非常短的命令行jsdoc -c pathTo\conf.json，类似下面的文件，它指定文档的源，目标等。该文件通过告诉doc生成器在“source”部分中使用conf.json将概述放入主页面，并使用new {{将标题从“Home”更改为新标题“MyDescription”。 1}}“opts”部分中的文件夹。
```
README.md
```

Answer 3

您还可以向一个或多个源文件添加@file（或@fileOverview）。

所有文件的概述部分都将包含在JSDoc主页中。如果您还将自述文件提供给JSDoc，则文件概述将放在自述文件内容之后。

示例：

/**
 * @file index.js is the root file for the example.
 * It kicks things off.
 * @author Your name goes here
 * @see <a href="https://developers.docusign.com">DocuSign Developer Center</a>
 */

Answer 4

＆＃39;首页＆＃39;在默认模板中进行了编码（在生成索引时传递为title），因此没有可以设置的变量或配置来修改此标题。

如果有多人在生成/编辑文档，那么编辑node_modules显然是不行的。

足以创建layout.tmpl（或完整的自定义模板，如果您正在使用它），将JSDoc指向它（CLI选项或配置文件）并替换<?js= title ?>与<?js= title==='Home' ? 'Your Title' : title ?>。

Answer 5

我在首页上遇到了类似但不同的问题。我想为其生成JSDOC页面的小型内部JavaScript库只是一组全局函数，而我根本不想显示主页。我只想显示global.html页面。

由于我们使用NPM来安装JSDOC，所以我不想复制整个模块只是为了自定义全局页面。相反，我只将布局页面复制到一个单独的目录，并在我的jsdoc.json配置文件中指定了该文件：

"templates" : {
"default": {
  "layoutFile": "config/layout.tmpl"
}

}

，然后我编辑layout.tmpl以添加

JSDoc的默认“主页”文本和内容

5 个答案:

生成主页

更改“主页”文字

步骤