目的は、 doccoが生成したfluentnodeのドキュメント(Coffee-Script で記述) をできるだけ読みやすく、理解しやすいものにすることです。現時点では、 http://o2platform.com/fluentnode/index.htmlでアクセスできるヘルプ ページの左側にある関数名を表す最善の方法に苦労しています。
現在、次の 3 つの構文オプションを検討しています。
あ）@. {関数名} ({params}) B) {クラス名}:: {関数名} ({params}) C) {クラス名}# {関数名} ({params})
例として、Array の .empty()メソッドは次のように表されます。
あ）@. 空()
B) 配列::空()
C) 配列番号空()
これは特定のクラスのファイル内で見られることに注意してください (したがって、これが配列に関連していることは A でも明らかです)。
これを実際に確認するために、3 つの異なるヘルプ ファイルでこれらの方法論を使用しました。
あ）@. Array.htmlの {関数名} ({params})
B) {ClassName}:: Function.htmlの{関数名} ({params})
C) {ClassName}# {関数名} ({params}) on C) http://o2platform.com/fluentnode/Number.html
ところで: これを表す他の方法がある場合は、それらの手法を表す既存の docco 生成サイトを教えてください。
(ここでも質問されます https://github.com/o2platform/fluentnode/issues/31 )