Skip to content
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

Add TSDoc support #63893

Closed
xiaoxiangmoe opened this issue Nov 28, 2018 · 1 comment
Closed

Add TSDoc support #63893

xiaoxiangmoe opened this issue Nov 28, 2018 · 1 comment
Assignees
Labels
feature-request Request for new features or functionality upstream Issue identified as 'upstream' component related (exists outside of VS Code)

Comments

@xiaoxiangmoe
Copy link
Contributor

xiaoxiangmoe commented Nov 28, 2018

related: #63106

playground:

https://microsoft.github.io/tsdoc/

the summary will be shown followed by the remarks section

Code samples can be enclosed in a Markdown code fence

image

tsdoc source file as follows:

/**
 * The summary section should be brief. On a documentation web site,
 * it will be shown on a page that lists summaries for many different
 * API items.  On a detail page for a single item, the summary will be
 * shown followed by the remarks section (if any).
 *
 * @remarks
 *
 * The main documentation for an API item is separated into a brief
 * "summary" section optionally followed by an `@remarks` block containing
 * additional details.
 *
 * Unlike the summary, the remarks block may contain lengthy documentation
 * content.  The remarks should not restate information from the summary,
 * since the summary section will always be displayed wherever the remarks
 * section appears.  Other sections (e.g. an `@example` block) if shown
 * will usually appear after the remarks section.
 *
 * Code samples can be enclosed in a Markdown code fence:
 * ```ts
 * function getAverage(x, y) {
 *   return (x + y) / 2.0;
 * }
 * ```
 *
 * If you use special symbols and don't want to use a code span, you can
 * escape them using backslashes:  \{\@inheritDoc Button.render\}
 *
 * @sampleCustomBlockTag
 *
 * You can define your own custom block tags and tell the parser about them.
 * The playground doesn't render this block, but your own tooling could do that.
 *
 * @privateRemarks
 *
 * The `@privateRemarks` tag starts a block of additional commentary that is not meant
 * for an external audience.  A documentation tool must omit this content from an
 * API reference web site.  It should also be omitted when generating a normalized
 * *.d.ts file.
 *
 * Modifiers look like block tags, but they do not start a documentation block.
 * For example this `@sealed` tag tells us that nobody should inherit from the
 * class.  But if text appeared after it, that text would get attached to the
 * previous block.
 *
 * @sealed
 */

but in vscode, no hightlight supported:

image

@jrieken jrieken assigned mjbvz and unassigned jrieken Nov 28, 2018
@mjbvz mjbvz added the feature-request Request for new features or functionality label Nov 28, 2018
@mjbvz
Copy link
Collaborator

mjbvz commented Nov 28, 2018

Opened microsoft/TypeScript-TmLanguage#688 and #63942 to track the individual requests

Let me know if this does not cover what you are looking for

@mjbvz mjbvz closed this as completed Nov 28, 2018
@mjbvz mjbvz added the upstream Issue identified as 'upstream' component related (exists outside of VS Code) label Nov 28, 2018
@vscodebot vscodebot bot locked and limited conversation to collaborators Jan 12, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
feature-request Request for new features or functionality upstream Issue identified as 'upstream' component related (exists outside of VS Code)
Projects
None yet
Development

No branches or pull requests

3 participants