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 页面，但是当我转到由yuidoc --server.

更新

这是我的评论。

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

有任何想法吗？

谢谢！

4

2 回答 2

2

yuidoc 不会查看您的代码，而是查看以 /** 开头并包含正确关键字的注释。您可以从根本不包含任何代码、仅包含适当注释的文件创建 API 文档，相反，您将不会从没有注释的纯代码中获得任何文档，就像您的情况一样。

于 2013-03-08T20:57:12.630 回答
0

yuidocjs v0.3.19以后支持解析咖啡评​​论语法（0.3.19以后的版本已经支持CoffeeScript）看这里

添加 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
###
于 2013-05-19T11:39:38.460 回答