trezm/type-doc

Investigate the idea of structs

trezm opened this issue · 0 comments

trezm commented

Classes represent objects that can and should be created with the new keyword. I think it would be useful to have the idea of structs, i.e. a group of properties (in a POJO) that all follow the same format.

Structs would have to live in comments, as their declarations are obviously not legal js, I would propose something like this:

/**
 * struct:name {
 *   first: string,
 *   middle: string?
 *   last: string
 * }
 */