用JSDoc评论Angular 2/Ionic 2项目

Question

我正在尝试使用JSDoc开始记录我的Ionic 2应用程序,但我在使用Angular 2的语法时遇到了困难.

例如,我的应用程序顶部有以下代码:

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

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

  }
})

在尝试解析此文件时,由于@App,JSDoc会出现此错误:

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

另外,我的构造函数看起来像这样(我使用了Ionic 2的教程模板):

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

  }
}

这会产生错误:

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

有人可以告诉我如何解决这些错误？

谢谢你的帮助.

Answer 1

Angular2使用在ES6上增强的TypeScript,但实际上并不是JavaScript,因此JSDoc无法理解它.尝试使用typedoc:http://typedoc.org/