-
Notifications
You must be signed in to change notification settings - Fork 131
-
Notifications
You must be signed in to change notification settings - Fork 131
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support tables in TSDoc comments #421
Comments
The included example works fine in VSCode IntelliSense already including if there are links within the cells, and is valid markdown, so I think picking that format would make sense. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
It is frequently useful to break information down into table form. This feature request is not attempting to prescribe a syntax, but using Markdown syntax as an example, it would be VERY nice to be able to write a comment like the following:
And have related tooling (VSCode intellisense, API-Extractor, etc.) correctly recognize the syntax and display the contents as a table.
Note that being able to use other TSDoc tags / syntax within the table is also desired. E.g. being able to leverage
{@link }
tags within the table.This could be solved via #12, but that issue has been open for 6 years now, so a smaller / scoped feature request seems appropriate.
The text was updated successfully, but these errors were encountered: