向JavaScript函数添加文档的标准方法是什么？ [英] What is the standard way of adding documentation to a JavaScript function?

问题描述

我正在考虑为JavaScript项目生成API文档。 JavaScript有什么类似Python的docstring？

  function add（a，b）{
 / ** 
返回a和b的总和。 
 * / 
 return（a  -  0）+（b  -  0）; 
} 
  

解决方案

你看过 JSDoc （现已被 JSDoc工具包 ）？

I'm looking at generating API docs for a JavaScript project. Does JavaScript have anything similar to Python's docstring?

function add(a, b) {
  /**
    Returns the sum of `a` and `b`.
  */
  return (a - 0) + (b - 0);
}

解决方案

Have you seen JSDoc (which has now been superceded by JSDoc toolkit)?

这篇关于向JavaScript函数添加文档的标准方法是什么？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！