Description
Right now every comment is a JSDoc comment which take up min. 3 lines per field:
export interface MyInterface {
/**
* Field description.
*/
myMember: null;
}
The idea is to provide something like a "compact" mode for comments with just a single line where JSDoc is written like:
export interface MyInterface {
/** Field description. */
myMember: null;
}
Personally I would like to have this as the default behavior, since this makes the generated types much more readable (the vast majority of descriptions are exactly a single line long in my case), but I understand everyone who thinks differently.
If this should not be the default behavior, this feature could be implemented via the comments option in every plugin. Instead of just accepting a boolean it could accept either a string / enum or a detailed options object where more options could be exposed in the future.
Description
Right now every comment is a JSDoc comment which take up min. 3 lines per field:
The idea is to provide something like a "compact" mode for comments with just a single line where JSDoc is written like:
Personally I would like to have this as the default behavior, since this makes the generated types much more readable (the vast majority of descriptions are exactly a single line long in my case), but I understand everyone who thinks differently.
If this should not be the default behavior, this feature could be implemented via the
commentsoption in every plugin. Instead of just accepting abooleanit could accept either astring / enumor a detailed optionsobjectwhere more options could be exposed in the future.