利用docstrings

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

编辑:

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, '.', '.', '-');
  }

...

})();

与$ 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»将创建一个新的*行,而write @将建议您(在intellisense中)所有JSDoc注释,并验证创建一个完整的行.

正确记录文件后,只需使用jsdocCLI创建文档即可.

文档:http://usejsdoc.org/

编辑:我刚刚意识到你的问题的答案在你的https://github.com/spadgos/sublime-jsdocs链接中,所以也许你想知道如何生成文档所以......

安装Node.js并使用CLI命令

npm install jsdoc -g

然后,假设您想要文件的文件名foo.js,运行以下命令:

jsdoc foo.js

这将在out目录中创建文档.

生成doc的所有CLI文档都在这里:http://usejsdoc.org/about-commandline.html