如何在 compodoc + angular2 中正确记录接口属性

Question

我已经开始使用 compodoc 来记录我的应用程序，并且在评论记录 openWeather api 界面时，我正在努力获得干净的代码。

我已经尝试了常见的 @property JSDoc 标记，但它不适用于 compodoc，因此要使其按预期工作，我需要编写类似这样的内容

/**
 * Weather information
 */
interface CityWeather {
  /**
   * Weather condition id
   */
  id: number;

  /**
   * Group of weather parameters (Rain, Snow, Extreme etc.)
   */
  main: string;

  /**
   * Weather condition within the group
   */
  description: string;

  /**
   * Weather icon id
   */
  icon: string;
}

我希望只在代码的开头有注释，而不是在每个属性之上，就像旧的 JSDoc @property {type} [name] 像下面这样的东西甚至可能吗？或者比上面更简洁的方法？

/**
 * Weather information
 *
 * @property id Weather condition id
 * @property main Group of weather parameters (Rain, Snow, Extreme etc.)
 * @property description Weather condition within the group
 * @property icon Weather icon id
 */
interface CityWeather {
  id: number;
  main: string;
  description: string;
  icon: string;
}

我这边的小编辑

注释不需要换行，你可以在一行中包含所有内容 /** */，像这样：

/** Weather information */
export interface CityWeather {
  /** Weather condition id */
  id: number;

  /** Group of weather parameters (Rain, Snow, Extreme etc.) */
  main: string;

  /** Weather condition within the group */
  description: string;

  /** Weather icon id */
  icon: string;
}

Answer 1

目前不支持此功能，但已在 compodoc github 问题中提出 feature request。

如何在 compodoc + angular2 中正确记录接口属性

How to properly document interface properties in compodoc + angular2

angular

typescript

documentation-generation

compodoc