microsoft / microsoft/TypeScript
Syntax highlighting can not resolve @throws of tsdoc
まだ誰も着手していません。
- 主要言語
- Go
- スター
- 111k
- フォーク
- 14.4k
- 平均マージ
- 1日 19時間
- マージ済み PR(30日)
- 117
説明
Type: Bug
Syntax highlighting for typescript has problem for the function that has @throws .
TSDoc used @throws {@link IsbnSyntaxError} format but VSCode shows broken lint text with break-lines like below:
// from tsdoc sample: https://tsdoc.org/pages/tags/throws/
type Book = any;
/**
* @throws {@link IsbnSyntaxError}
* This exception is thrown if the input is not a valid ISBN number.
*/
function fetchBookByIsbn(isbnCode: string): Book {}
I thought vscode does not support tsdoc and using jsdoc but jsdoc does not shows correct info too. (this may be related with: https://github.com/microsoft/vscode/issues/135417 )
I expected it shows a link for the Type, at least shows as simple text without break-line.
I may have to report this on other project (TmLanguage? https://github.com/microsoft/TypeScript-TmLanguage/issues) but I did here from VSCode reporter anyway.
VS Code version: Code 1.89.1 (dc96b837cf6bb4af9cd736aa3af08cf8279f7685, 2024-05-07T05:13:33.891Z)
OS version: Windows_NT x64 10.0.19045
Modes:
System Info
| Item | Value |
|---|---|
| CPUs | Intel(R) Core(TM) i5-8500 CPU @ 3.00GHz (6 x 3000) |
| GPU Status | 2d_canvas: enabled canvas_oop_rasterization: enabled_on direct_rendering_display_compositor: disabled_off_ok gpu_compositing: enabled multiple_raster_threads: enabled_on opengl: enabled_on rasterization: enabled raw_draw: disabled_off_ok skia_graphite: disabled_off video_decode: enabled video_encode: enabled vulkan: disabled_off webgl: enabled webgl2: enabled webgpu: enabled |
| Load (avg) | undefined |
| Memory (System) | 31.78GB (11.72GB free) |
| Process Argv | --disable-extensions --crash-reporter-id ca2a1b94-1896-42fa-87dc-e58738a43fa3 |
| Screen Reader | no |
| VM | 0% |
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
VS Code 1.89.1 で @throws {@link IsbnSyntaxError} を使用する TSDoc サンプルを使って問題を再現してください。まず、報告で示唆されているように、構文ハイライトが TypeScript-TmLanguage プロジェクトに実装されているかを確認し、issue #135417 と比較してください。タグがリンクとして、または少なくとも分割されていないプレーンテキストとして表示されれば完了です。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript, vscode
- 領域
- developer-experience, tooling
- issue の種類
- バグ
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 28/100