7.7 Enum and typedef comments

All enums and typedefs must be documented with appropriate JSDoc tags(@typedef or @enum) on the preceding line. Public enums and typedefs mustalso have a description. Individual enum items may be documented with a JSDoccomment on the preceding line.

  1. /**
  2.  * A useful type union, which is reused often.
  3.  * @typedef {!Bandersnatch|!BandersnatchType}
  4.  */
  5. let CoolUnionType;
  8. /**
  9.  * Types of bandersnatches.
  10.  * @enum {string}
  11.  */
  12. const BandersnatchType = {
  13.   /** This kind is really frumious. */
  14.   FRUMIOUS: 'frumious',
  15.   /** The less-frumious kind. */
  16.   MANXOME: 'manxome',
  17. };

Typedefs are useful for defining short record types, or aliases for unions,complex functions, or generic types.Typedefs should be avoided for record types with many fields, since they do notallow documenting individual fields, nor using templates or recursivereferences.For large record types, prefer @record.