JSDoc

2016-03-31 46 views
3

ile Açısal 2/İyonik 2 projesini yorumlama JSDoc kullanarak İyonik 2 uygulamamı belgelemeye başladım ancak bunu Angular 2'nin sözdizimi ile kullanmakta zorluk çekiyorum.JSDoc

Örneğin, benim app üstündeki aşağıdaki kodu vardır:

ERROR: Unable to parse /home/user/Projects/mobileApp/app/app.js: Line 4: Unexpected token ILLEGAL

:

import {App, Events, IonicApp, Platform} from 'ionic-framework/ionic'; 
import {UserData} from './providers/user-data'; 

@App({ 
    templateUrl: 'build/app.html', 
    providers: [UserData], 
    config: { 

    } 
}) 

bu dosyayı ayrıştırmak çalışırken, JSDoc çünkü @App bu hata veriyor

Ayrıca, kurucularım buna benziyor (Iyonik 2'nin öğretici şablonunu kullandım):

class MyApp { 
    constructor(app: IonicApp, platform: Platform, events: Events, userData: UserData) { 

    } 
} 

Ve bu hata üretir:

ERROR: Unable to parse /home/user/Projects/mobileApp/app/app.js: Line 27: Unexpected token :

birisi nasıl bu hataları almak için söyleyebilir misiniz?

Yardımlarınız için teşekkür ederiz.

cevap

5

Angular2, ES6'da zenginleştirilmiş, ancak aslında bir JavaScript değil, bu yüzden JSDoc'un bunu anlamadığı bir TypeScript kullanır. Typedoc kullanmayı deneyin: http://typedoc.org/

+0

Teşekkür ederim, ben kontrol edeceğim. Ben Ionic2 & Angular2 ve tipcript değil Javascript sürümünü kullanıyorum, hala geçerli mi? –

+0

Verilen örneklerde, TypeScript (tür ek açıklamaları, dekoratörler) kullanıyorsunuz. Tabii ki, çalışma zamanı (veya dağıtım) sırasında uygulamanız ham JavaScript'e aktarılır (hiçbir tarayıcı doğrudan TypeScript'i desteklemez). http://stackoverflow.com/questions/12694530/what-is-typescript-and-why-would-i-use-it-in-place-of-javascript'in farklılıkları hakkında daha fazla açıklama var. –

+0

TypeDoc gerçekten iyi çalışıyor, bahşiş için teşekkürler. İyonik'in yazıya dökülmüş versiyonunun da verilmesi, daha popüler hale geldiği için, bunu öğrenebilir. –

0

ES7 JS kodu, JSDoc'a beslenmeden önce ES5'e (Babel aracılığıyla) veya ES6'ya (.Script dosyaları .ts dosyaları ile yeniden adlandırılmış) aktarılmalıdır.

Belgeleme oluşturma işlemi, uygulama oluşturma işleminden bağımsız olabilir.