Coffeescript 如何在Docco生成的文件中表示函数名？

目标是使生成的文档（用咖啡脚本编写）尽可能易于阅读和理解。目前，我正在努力寻找在帮助页面左侧表示函数名的最佳方法，您可以在

目前，我正在探索三种语法选项：

A） @.{function name}（{params}） B） {ClassName}：：{function name}（{params}） C） {ClassName}{strong>{function name}（{params}）

例如，数组的.empty（）方法将表示为：

A） @.为空（）

B） 数组：：空

C） 数组#空（）

请注意，这将在特定类的文件中看到（因此，在一个实例中，这显然与数组相关）

为了看到这一点，我在三个不同的帮助文件中使用了这些方法：

---

A） @.{function name}（{params}）在

B） {ClassName}：：{function name}（{params}）on

C） {ClassName}{strong>{function name}（C上的{params}）http://o2platform.com/fluentnode/Number.html

---

顺便说一句：如果有其他的方法来表示这一点，请告诉我现有的docco生成的网站，代表这些技术

---

（这里也有问题）

我选择了选项a）的一个变体，即

@.empty{parmas}

---

如果我没有在参数中使用（），那么就很容易看到它们

我想这都是我的观点，但我还是要发表一些评论。A似乎有误导性，因为你很少说

@push（…）

，你几乎总是说

A.push（…）

；B与咖啡脚本匹配，因此对我来说最有意义；Ruby的人可能很熟悉C，但我不知道其他人。是的，因此我最初使用B是出于这个原因，但在写了很多这样的描述之后，我开始意识到，当我需要提到实际被扩展的对象时，使用@char更有意义，因为它在coffee脚本中代表了这一点（这是所有方法都使用的语言）。这意味着当谈论@.push（…）@实际上表示受推送影响的对象。当然，

@

是有意义的，如果这是你的意思，但是如果你谈论的是方法，那么

Class:：method

是唯一对我有意义的东西。顺便说一句，注意文档中的空格，

f（x，y）

和

f（x，y）

是非常不同的东西；如果要使用括号，请正确使用它们。我对Class:：方法的问题是，在这样的页面上使用Class有点多余，特别是当您希望能够快速阅读函数并找到特定函数时。关于函数调用上的额外空间，您是对的，我担心这可能会有点问题（因为在Coffee脚本中，空格会起作用）。我尝试使用该空格使函数名更具可读性。