用 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: {

  }
})

当试图解析这个文件时，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 使用在 ES6 上增强的 TypeScript 但实际上不是 JavaScript，所以 JSDoc 不理解它的原因。尝试在以下位置使用 typedoc：http://typedoc.org/

Answer 2

ES7 JS 代码应先转译为 ES5（通过 Babel）或 ES6（通过 TypeScript，并将 .js 文件重命名为 .ts），然后再提供给 JSDoc。

文档构建过程可能独立于应用程序捆绑过程。

用 JSDoc 评论 Angular 2 / Ionic 2 项目

Commenting Angular 2 / Ionic 2 project with JSDoc

jsdoc

jsdoc3

ionic2

angular