2013-03-08 2 views
0

coffeescript를 사용하기 위해 yuidoc을 설정 한 사람이 있습니까? 내가 yuidoc -c yuidoc.json . 클래스의 예제를 실행하면yuidoc은 coffeescript에서 작동합니까?

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

내가 api.js 파일에 표시 제작과 HTML 페이지가 생성되지만 아무것도 내가 이동 "클래스"아래에 보여줍니다 : 여기 내 yuidoc.json 파일입니다 yuidoc --server에 의해 생성 된 URL. 여기

업데이트 내 의견이다.

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

아이디어가 있으십니까?

감사합니다.

답변

0

yuidocjs (0.3.19 以后 的 版本 已经 支持 커피 스크립트는)

here는 커피 스크립트 주석 구문 지원 추가를 참조하십시오.

set options --syntaxtype coffee. 

$ yuidoc --syntaxtype coffee -e .coffee input 

는 커피 스크립트의 코드입니다 :

나는 내 코드에서 한 주석을 표시하는 내 질문에 업데이트
###* 
# 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

늦어서 죄송합니다. 도움에 감사드립니다. 내가 넣을 때 :'file :: // path/to/index.html' 모든 클래스 등이 나타난다. 'yuidoc --server -c yuidoc.json'을 실행하면 어떤 클래스도 보여주지 않습니다. 무슨 일이 벌어 질 지에 대한 아이디어가 있습니까? 감사! – brink

+0

이것은 "以后 的 版本 已经 支持"이 무엇입니까? –

+0

버전 지원 후 == 후행 버전 본문지지 – ruanjf

2

yuidoc은 코드를 보지 않지만/**로 시작하는 주석에는 적절한 키워드가 들어 있습니다. 코드가 전혀없는 파일에서 API 문서를 만들 수 있습니다. 적절한 의견 만 제공 할 수 있으며, 반대로 댓글이없는 일반 코드로는 문서를 가져올 수 없습니다. V0.3.19 지원 구문 분석 커피 주석 구문 후

+0

. [this] (https://github.com/yui/yuidoc/pull/56)에 따르면 coffeescript 주석이 작동해야합니다. – brink

관련 문제