tsdiagram
tsdiagram copied to clipboard
Add a description
Any chance you'd consider adding a description to the fields? Could be implemented for example using decorators, would look like this:
interface SomeType {
fieldWithNoDescription: string;
@Description("some description")
fieldWithDescription: string;
}
Yes, any suggestions on how to render the descriptions? I think comment blocks might be better for multi-line, maybe with a special prefix ex ///
I think multiline could work with template strings:
@Description(`
Some
multiline
description
`)
But yeah, comments are fine as well.
I was thinking of rendering them as a 3rd column, but I'm not great at UX, so maybe it's a bad idea.