7.9 Property comments

Property types must be documented. The description may be omitted for privateproperties, if name and type provide enough documentation for understanding thecode.

Publicly exported constants are commented the same way as properties.

  1. /** My class. */
  2. class MyClass {
  3.   /** @param {string=} someString */
  4.   constructor(someString = 'default string') {
  5.     /** @private @const {string} */
  6.     this.someString_ = someString;
  8.     /** @private @const {!OtherType} */
  9.     this.someOtherThing_ = functionThatReturnsAThing();
  11.     /**
  12.      * Maximum number of things per pane.
  13.      * @type {number}
  14.      */
  15.     this.someProperty = 4;
  16.   }
  17. }
  19. /**
  20.  * The number of times we'll try before giving up.
  21.  * @const {number}
  22.  */
  23. MyClass.RETRY_COUNT = 33;