用JSDoc评测角2/离子2方案

Question

我试图开始使用JSDoc来记录我的Ionic 2应用程序，但是我很难用角2的语法来使用它。

例如，我的应用程序顶部有以下代码：

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

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

  }
})

当试图解析这个文件时，JSDoc会给出这个错误，因为@App：

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使用的TypeScript是在ES6上扩展的，但实际上不是JavaScript，所以JSDoc不理解它。尝试使用typedoc at：http://typedoc.org/

Answer 2

ES7 JS代码应该被转换到ES5 (通过Babel)或ES6 (通过TypeScript，并将.js文件重命名为.ts)，然后再输入给JSDoc。

文档构建过程可以独立于应用程序绑定过程。