0

目标是使 fluentnode 的docco生成的文档(用 Coffee-Script 编写)尽可能易于阅读和理解。目前,我正在努力寻找在帮助页面左侧表示函数名称的最佳方式,您可以在http://o2platform.com/fluentnode/index.html访问

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

一种) @。{function-name} ({params}) B) {ClassName}:: {function-name} ({params}) C) {ClassName}# {function-name} ({params})

例如,Array 的 .empty()方法将表示为:

一种) @。()

B)数组::()

C) 数组#empty ()

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

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


一种) @。Array.html上的 {function-name} ({params})

图片

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

图片

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

图片


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

(这里也问过问题https://github.com/o2platform/fluentnode/issues/31

4

1 回答 1

0

我将使用选项 A) 的变体,即

@.empty {帕尔马斯}

我没有在参数中使用 () 的地方很容易看到它们

于 2015-01-04T16:35:20.343 回答