openHacking/api-extractor-snippet

API Extractor doc comment syntax for vscode extension

JavaScriptMIT

API Extractor Snippet

Introduction

Implemented code hints for Doc comment syntax when using API Extractor to generate API documentation

Usage

Install the extension

Make sure settings.json contains the following configuration

 // use tab to complete
"editor.tabCompletion": "on",
// Configure the order of snippets and other code hints
"editor.snippetSuggestions": "top",
// Support comment code hints
"editor.quickSuggestions": {
  "comments": true
}

Feature

All tags below have been implemented

@alpha
@beta
@defaultValue
@deprecated
@eventProperty
@example
{@inheritDoc}
@internal
{@link}
@override
@packageDocumentation
@param
@preapproved
@privateRemarks
@public
@readonly
@remarks
@returns
@sealed
@typeParam
@virtual