0

誰かがyuidocをcoffeescriptで動作するように設定したことがありますか？これが私のyuidoc.jsonファイルです：

{
  "name": "App",
  "description": "App",
  "version": "1",
  "url": "http://example.com",
  "options": {
    "paths": [
      "./"
             ],
   "exclude": "vendor",
   "syntaxtype": "coffee",
   "extension": ".coffee",
   "outdir": "./api_docs"
  }
}

作成したサンプルクラスを実行yuidoc -c yuidoc.json .すると、api.jsファイルに表示され、htmlページが生成されますが、によって生成されたURLに移動すると、[クラス]の下に何も表示されませんyuidoc --server。

アップデート

これが私のコメントです。

###*
# Description
#
# @project MyProject
# @author Me
# @class MyClass
###

何か案は？

ありがとう！

4

2 に答える 2

2

yuidocはコードを調べませんが、/ **で始まり、適切なキーワードを含むコメントを調べます。コードをまったく含まず、適切なコメントだけを含むファイルからAPIドキュメントを作成できます。逆に、あなたの場合のように、コメントのないプレーンコードからドキュメントを取得することはできません。

于 2013-03-08T20:57:12.630 に答える
0

V0.3.19以降のyuidocjsは、コーヒーコメント構文の解析をサポートしています（0.3.19以后的版本已经購買CoffeeScript）ここを参照してください

CoffeeScriptコメント構文のサポートを追加します。

set options --syntaxtype coffee.

$ yuidoc --syntaxtype coffee -e .coffee input

ThiはCoffeeScriptのコードです：

###*
# The test project
# @project tester
# @title The Tester
# @icon http://a.img
# @url http://one.url
# @url http://two.url
# @author admo
# @contributor davglass
# @contributor entropy
###
于 2013-05-19T11:39:38.460 に答える