https://github.com/openhacking/api-extractor-snippet
API Extractor doc comment syntax for vscode extension
https://github.com/openhacking/api-extractor-snippet
Last synced: about 1 year ago
JSON representation
API Extractor doc comment syntax for vscode extension
- Host: GitHub
- URL: https://github.com/openhacking/api-extractor-snippet
- Owner: openHacking
- License: mit
- Created: 2022-06-30T07:46:45.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-30T08:35:36.000Z (almost 4 years ago)
- Last Synced: 2025-02-01T07:26:32.223Z (over 1 year ago)
- Language: JavaScript
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# API Extractor Snippet
## Introduction
Implemented code hints for [Doc comment syntax](https://api-extractor.com/pages/tsdoc/doc_comment_syntax/) when using API Extractor to generate API documentation
## Usage
1. Install the extension
2. Make sure `settings.json` contains the following configuration
```json
// 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