Question

我很想知道如何使用文本信息轻松地注释JavaScript函数（描述函数的功能，使用哪些参数，返回等等），以便可以从控制台访问它。

在Matlab中，例如，通过在函数标题下方注释文本并通过在控制台中键入help myFunction来访问它来完成此操作。

来自Mathworks的示例：

myFunction c = addme(a,b)
% ADDME  Add two values together.
%   C = ADDME(A) adds A to itself.
%   C = ADDME(A,B) adds A and B together.
%
%   See also SUM, PLUS.

switch nargin
    case 2
        c = a + b;
    case 1
        c = a + a;
    otherwise
        c = 0;
end

JavaScript中的（或）等效方法是什么？

Answer 1

Javascript并不适合交互式使用，因此该语言没有标准模式。

但是，函数是对象。因此，您可以为myFunction.help分配值：

function myFunction(a, b) {
    …
}
myFunction.help = "Here is some help text";

此值不会在控制台的任何位置专门公开，但可以通过阅读myFunction.help获得。

Answer 2

您可以使用JSDoc向JS函数添加文档（参数，返回，行为等）。但它不能以您需要的交互方式提供。它包括一个文档生成器，可以从文档中生成用户友好的（静态）HTML页面，您可以浏览它们。

控制台中的JavaScript函数“帮助文本”

2 个答案: