JSDoc remark

Posted on In

Class in ES2015

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
 * Class representing a point.
 */
class Point {
  /**
   * Create a point.
   * @param {number} x - The x value.
   * @param {number} y - The y value.
   */
  constructor(x, y) {}

  /**
   * Get the x value.
   * @return {number} The x value.
   */
  getX() {}

  /**
   * Convert a string containing two comma-separated number into a point.
   * @param {string} str - The string containing two comma-separated number.
   * @return {Point} A point object.
   */
  static fromStringStr(str) {}
}

extends

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
 * Class representing a point.
 * @extends Point
 */
class Dot extends Point {
  /**
   * Create a dot.
   * @param {number} x - The x value.
   * @param {number} y - The y value.
   * @param {number} width - The width of the dot.
   */
  constructor(x, y, width) {
    super(x, y)
  }

  /**
   * Get the width of the dot.
   * @return {number} The dot's width.
   */
  getWidth() {}
}

@abstract

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
/**
 * Foo.
 * @constructor
 */
function Foo() {}

/**
 * Check if is solid.
 * @abstract
 * @return {boolean}
 */
Foo.prototype.isSolid = function () {
  throw new Error("Must be implemented by suclass.")
}

/**
 * Bar.
 * @constructor
 * @arguments Foo
 */
function Bar() {}

/**
 * Check if is solid.
 * @return {boolean} Always return false.
 */
Bar.prototype.isSolid = function () {
  return false
}

@assets

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
/**
 * @constructor
 */
function Foo() {
  /**
   * @assets private
   * @type {number}
   */
  let foo = 0

  /**
   * @assets protected
   * @type {string}
   */
  this.bar = "1"

  /**
   * @assets package
   * @type {string}
   */
  this.barz = "2"

  /**
   * @assets public
   * @type {string}
   */
  this.barm = "3"
}

@author

1
2
3
4
/**
 * @author Edward <wang.huiyang@outlook.com>
 */
function MyClass() {}

@callback

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * @class
 */
function Foo() {}

/**
 * Send a request.
 * @param {requestCallback} cb - The callback than handles the response.
 */
Foo.prototype.send = function (cb) {}

/**
 * Callback
 * @callback requestCallback
 * @param {number} responseCode
 * @param {string} responseMessage
 */

@event

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
/**
 * @constructor
 */
function Foo() {}

/**
 * Do some test.
 * @fires Foo#test
 */
Foo.prototype.test = function () {}

/**
 * Foo test.
 * @event Foo#test
 * @type {object}
 * @property {boolean} isPass - Check if is pass.
 */