feat(formats) Use TSDoc comment format for typescript/es6-declarations #950
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #, if available:
Description of changes: Use TSDoc comment format for
typescript/es6-declarations
Why: So developers can see the comment on hover in their editor (e.g. VSCode)
Before:
![Screenshot 2023-03-15 at 3 49 30 PM](https://user-images.githubusercontent.com/127199/225460633-4bdf0708-9caf-4a35-b879-d24c8a728f6e.png)
After:
![image](https://user-images.githubusercontent.com/127199/225460731-4aa922a6-0a8b-4343-adff-d637e5e896ce.png)
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.