使用文档字符串

这是一个新手问题，但我没有设法在谷歌上搜索任何关于这个主题的相当简洁但具有启发性的内容。我有Sublime Text编辑器和优秀的插件DocBlockr https://github.com/spadgos/sublime-jsdocs https://github.com/spadgos/sublime-jsdocs，这使得正确的评论变得轻而易举。评论完后我应该做什么？至少，我希望能够在 REPL 中调用注释。还有哪些可用的文档？我想要一些轻量级且简单的东西，用于中等脚本。

EDIT:

var helper = exports.helper = (function() {

...

  /**
   * Reduces a sequence of names to initials.
   * @param  {String} name  Space Delimited sequence of names.
   * @param  {String} sep   A period separating the initials.
   * @param  {String} trail A period ending the initials.
   * @param  {String} hyph  A hypen separating double names.
   * @return {String}       Properly formatted initials.
   */
  function makeInits(name, sep, trail, hyph) {
    function splitBySpace(nm) {
      return nm.trim().split(/\s+/).map(function(x) {return x[0]}).join(sep).toUpperCase();
    }
    return name.split(hyph).map(splitBySpace).join(hyph) + trail;
  }
  /**
   * Reduces a sequence of names to initials.
   * @param  {String} name Space delimited sequence of names.
   * @return {String}      Properly formatted initials.
   */
  function makeInitials(name) {
    return makeInits(name, '.', '.', '-');
  }

...

})();

With $ jsdoc src.js没有错误，但只生成虚拟标头。

当你写下这个

function bar (foo) {
    return foo + foo;
}

如果您将光标放在上面的行中function你写/**当你按“Enter”键时，你会得到：

/**
 * [bar description]
 * @param  {[type]} foo [description]
 * @return {[type]}     [description]
 */
function bar (foo) {
    return foo + foo;
}

类似的快捷键还有很多。

例如，如果您将光标放在@param {[type]} foo [description]，按“Enter”将创建一个新的* 行，然后写@将建议您（在智能感知中）所有 JSDoc 注释和验证创建一个完整的行。

当您的文件被正确记录后，只需使用jsdocCLI 创建您的文档。

文档：https://jsdoc.app/ https://jsdoc.app/

编辑：我刚刚意识到对你问题的回答就在你的https://github.com/spadgos/sublime-jsdocs https://github.com/spadgos/sublime-jsdocs链接，所以也许您想知道如何生成文档，以便...

安装 Node.js 并使用 CLI 命令

npm install jsdoc -g

然后，假设您想要文档的文件名是foo.js，运行以下命令：

jsdoc foo.js

这将创建一个文档out目录。

生成 doc 的所有 CLI 文档都在这里：https://jsdoc.app/about-getting-started.html https://jsdoc.app/about-getting-started.html