Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

TSDoc: Support `@example` tag

See original GitHub issue

The @example tag in TSDoc has a different semantic than in JSDoc.

Issue Analytics

State:
Created 3 years ago
Comments:13 (10 by maintainers)

Top GitHub Comments

2reactions

hosseinmdcommented, Mar 4, 2021

https://github.com/hosseinmd/prettier-plugin-jsdoc/commit/4213aedd3b63e9dbc9e25c2b58a6e3cfcf7ede6b

1reaction

RunDevelopmentcommented, Feb 15, 2021

This not related to typescript

Of course it is related. TSDoc is the documentation standard for TS.

there is no reason your project can’t use this plugin

I already gave you the reason:

“Static site generators like TypeDoc do correctly support TSDoc’s @example tag. If this issue isn’t resolved, this plugin cannot be used in combination with TypeDoc and other software that implements the TSDoc standard.”

I use TypeDoc in my projects.

But I also want to remind you of this. Or is TSDoc isn’t going to be supported after all?

Top Results From Across the Web

TSDoc: @example

Indicates a documentation section that should be presented as an example illustrating how to use the API. It may include a code sample....

RFC: Syntax for @example tag #20 - microsoft/tsdoc - GitHub

I'm forking it into a separate issue since @c69 pointed out that the design is unclear. Can anyone find samples of its usage...

Tags - TypeDoc

TypeDoc supports defining what tags are supported through either a tsdoc.json file or via the --blockTags , --inlineTags , and --modifierTags options.

TSDoc Playground

TSDoc. Search documentation. Intro Tags GitHub Help Playground. Choose a sample... A basic example, Some advanced features, Creating hyperlinks.

TS: What is TSDoc?. The way to write the better comments

TSDoc might help you! ... TSDoc is based on JSDoc so it supports typescript extension as well as ... I prepare some examples...