3

jsdoc を使用してマングース モデル メソッドを文書化しようとしています。モデルのメソッドはモデルに属しているため、メンバーメソッドとして表示したいと思います。

このファイルには、トップレベルの@module models行も含まれています。

/**
 * @constructor
 */
var MySchema = new Schema({
  title: {
    type: String,
    required: true
  }
});

/**
 * My method
 *
 * @function myMethod
 * @memberof MySchema
 * @this MySchema
 * @param {ObjectId} object
 * @params {Array} roles, defaults to all
 * @returns Participant or null
 */
 MySchema.method('myMethod', function(object, roles) {
   // ...
 });

現在、クラス定義へのリンクを含むモジュール ページと、クラス定義を説明するページを受け取りましたが、これらのページのいずれにもメソッドが表示されません。を削除する@memberofと、メソッドがモジュール ページに表示されます。クラスのページに載せたいと思います。

jsdoc ドキュメントのどの部分が欠けていますか?

4

1 に答える 1

5

モジュールについて明示する必要があります。

@memberof module:models~MySchema

実際のところ、jsdoc は、現在のモジュール内にあるエンティティをMySchema意味するように指定すると、それを推測しません。MySchema

@this実際にはと同じです。モジュール名を持つように変更すると、ドキュメントの about の部分thisに の定義へのリンクが含まれますMySchema。

于 2015-02-15T12:22:02.710 に答える