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

时间:2014-12-26 18:30:27

标签: coffeescript functional-programming docco

目标是使docco生成的fluentnode文档(以Coffee-Script编写)尽可能易于阅读和理解。目前,我正在努力寻找帮助页面左侧的功能名称的最佳方式,您可以访问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)数组#()

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

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


A {@ 3}}上的@。 {function-name} ({params})

image

B Array.html

上的{ClassName} :: {function-name} ({params})

image

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

image


顺便说一下:如果有其他方式来表示这一点,请指出现有的docco生成的网站,代表这些技术。

(问题也在这里问Function.html

1 个答案:

答案 0 :(得分:0)

我选择了A)的变体

@。empty {parmas}

我在params中没有使用(),这样可以很容易地看到它们