VS Code extension for TSDoc

e.g.

interface SquareConfig {
    color?: string;
    width?: number;
}

[octogonz]

We might start by making a TSDoc extension for VS Code (similar to the recently released plugin for ESLint). This approach would also allow us to render the docs more nicely similar to what the playground does.

Before I would work on that myself, I have some higher priorities I’ve been wanting to wrap up, such as finishing the declaration reference parser and posting a spec that documents the TSDoc grammar in detail.

[octogonz]

I played around with this a bit today. Making a VS Code extension is very easy to do! In about 30 mins I was able to create a simple prototype that finds the nearest TSDoc comment and generates some markdown which gets rendered as a vscode.Hover object:

This was just an experiment, not a real solution.

But if someone’s feeling bored, making a TSDoc extension might be a pretty rewarding project. I probably don’t have time to undertake it myself, but I’m happy to help out with the design and any parsing/rendering aspects. (For example, for the TSDoc->Markdown part, maybe we can extract the MarkdownEmitter.ts from API Documenter and make it into a reusable library.)

CC @jsamr