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

Question

目的是使多科生成的流节点文档(用Coffee编写)尽可能容易阅读和理解。目前，我还在努力寻找最好的方法来表示您可以在http://o2platform.com/fluentnode/index.html访问的帮助页面左侧的函数名

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

( A) @.{function-name} ({params}) B) {ClassName}::{function-name} ({params}) C) {ClassName}#{function-name} ({params})

例如，数组的.empty()方法可以表示为：

( A) @.空 ()

B) Array::empty ()

( C) Array#空 ()

请注意，这将在特定类的文件中看到(因此在A上仍然很明显，这与数组有关)

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

( A) @.{function-name} ({params})在Array.html上

​

​

( B) {ClassName}::{function-name} ({params})在Function.html上

​

​

C) {ClassName}#{function-name} ({params}) on C) http://o2platform.com/fluentnode/Number.html

​

​

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

(https://github.com/o2platform/fluentnode/issues/31这里也提出了问题)

Answer 1

我将使用备选方案A的一个变体，即

@.empty {parmas}

在这里，我没有使用()在params中，这使得我很容易看到它们