Question

有没有人设置过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页面，但当我转到{{1}生成的url时，没有任何内容显示在“Classes”下}}

更新

以下是我的评论。

yuidoc --server

有什么想法吗？

谢谢！

Answer 1

yuidoc不会查看您的代码，而是查看以/ **开头且包含正确关键字的注释。您可以从一个根本不包含代码的文件创建API文档，只需要合适的注释，相反，您将不会使用没有注释的普通代码获取文档，就像您的情况一样。

Answer 2

yuidocjs之后V0.3.19支持解析咖啡评论语法（0.3.19以后的版本已经支持CoffeeScript）见here

添加CoffeeScript注释语法支持。

set options --syntaxtype coffee.

$ yuidoc --syntaxtype coffee -e .coffee input

这是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
###

yuidoc是否与coffeescript合作？

2 个答案: