首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >yuidoc和coffeescript一起工作吗?

yuidoc和coffeescript一起工作吗?
EN

Stack Overflow用户
提问于 2013-03-08 02:04:36
回答 2查看 931关注 0票数 0

有人设置过yuidoc来使用coffeescript吗?这是我的yuidoc.json文件:

代码语言:javascript
复制
{
  "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生成的url时,“yuidoc --server”下什么都没有显示出来。

更新

以下是我的评论。

代码语言:javascript
复制
###*
# Description
#
# @project MyProject
# @author Me
# @class MyClass
### 

有什么想法吗?

谢谢!

EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2013-05-19 11:39:38

支持解析咖啡注释语法(0.3.19以后的版本已经支持CoffeeScript)(参见以后的版本已经支持)

添加CoffeeScript注释语法支持。

代码语言:javascript
复制
set options --syntaxtype coffee.

$ yuidoc --syntaxtype coffee -e .coffee input

Thi是CoffeeScript的代码:

代码语言:javascript
复制
###*
# 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
###
票数 0
EN

Stack Overflow用户

发布于 2013-03-08 20:57:12

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

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/15285471

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档