代码之家 › 专栏 › 技术社区 › Clutch

如何记录匿名函数[[关闭]

jsdoc javadoc documentation javascript java

Clutch · 技术社区 · 14 年前

我特别指的是JavaScript匿名函数,但这可能与其他语言有关。我喜欢在我的脚本中使用JSDoc符号,因为我知道别人迟早会对它进行黑客攻击。当我有一个非常复杂的匿名函数时,人们如何记录它,以便Eclipse和其他理解JSDoc或JavaDoc符号的IDE能够识别它?

/**
 * Blah Blah blah
 *
 * @param Object Blah blah blah
 * @return Blah Blah Blah
 * @type Object
 */
function foo(this) {
......
this.bar = function () { ... complex code .....};
......
return obj;
}

谢谢

3 回复 | 直到 14 年前

Justin Ethier 14 年前

理想情况下,匿名函数应该很短,并执行简单的任务。所以。。。包含它的外部函数应该提供足够的文档。

如果不是这样,您应该将匿名函数提取到一个命名函数中,然后对其进行适当的文档记录。

Robusto 14 年前

这不是真正的匿名函数。它有个名字。名称是“bar”,或者更具体地说是“foo.bar”。在我看来,这实际上是一个函数。在我看来,真正的匿名函数是一个没有名字的函数,就像另一个函数的参数:

var intervalId = setTimeout(function() { // statements }, 1000);

,匿名函数是一个“用function()构造函数创建”的函数。不过,他对此避而不谈,因为他进一步指出,这类函数“有时”被称为匿名函数。

我为什么在这里提出这个问题?因为我认为,如果你有一个名字,它不能真正被称为匿名。我认为关于Javascript函数的术语“匿名”充其量是模棱两可的,至少应该由某个地方的人来澄清。

Pyrolistical 14 年前

我发现记录某事的最好方法就是不要这样做。我的意思是我使用好的变量/函数名和清晰的代码作为我的文档。

所以在这个例子中,我只需要创建一个静态函数来创建这个匿名函数,这样我就可以给这个静态函数起个好名字了

推荐文章

CryptoBird · 此文档是否正确?(是/否回答对我来说就足够了)

6 年前

Mike · 在JavaScript文件中使用类型化定义的vscode

6 年前

FabianTe · JSDoc:条件忽略是否可能?

7 年前

Everton Lenger · 带有jQuery参数的PhpStorm警告

7 年前

newBee · JSDoc@param-从另一个模块引用类

7 年前

Chacha · 不同文件中定义的对象的JSdoc

7 年前

a-h · jsdoc和vscode:记录作为参数传递给另一个函数的函数

7 年前

hkk David Calhoun · Tern无法使用JSDoc类型信息

7 年前

Pulasthi Bandara · 如何使用JsDoc记录解构参数

7 年前

Tom · 如何在WebStorm中的hover上启用intellisense/JSDoc信息?

7 年前