Highlight @example jsdoc body as source code
還沒有人認領這個 Issue。
評估
- 難度
- 3/5
- 預估耗時
- 1-2 天
- 新手友好度
- 42/100
- Issue 類型
- 功能
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- typescript
- 領域
- tooling
研究方向
檢查連結的 VS Code ExampleJsDoc.injection.tmLanguage.json,以及 repository 對 JSDoc 註解的 TypeScript/JavaScript grammar 處理。確認現有 injection 如何將開頭的星號與文件內容分開;完成條件是 @example 區塊的本文能夠獲得原始碼語法醒目提示。
由索引模型根據 Issue 內容生成。
描述
TS and JS Grammar Extension version: 0.0.47 / latest
Code
For a js doc body such as:
/**
* @example
* 1 + 1
*/
const a = 1
We mark the body of the @example block specially but do not actually syntax highlight it. I added an injection grammar in VS Code that does this: https://github.com/Microsoft/vscode/blob/master/extensions/typescript-basics/syntaxes/ExampleJsDoc.injection.tmLanguage.json
May be worth including in the core grammar. Let me know if you agree. The injection grammar will not work as is, we're relying on another injection grammar that handles separating the leading stars of the doc block from the documentation content itself
- 主要語言
- TypeScript
- 星號
- 471
- 分支
- 149
- PR 合併指標
- 30 天內沒有已合併 PR
貢獻指南
這個儲存庫沒有索引到貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
microsoft/TypeScript-TmLanguage 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 72/100
microsoft/TypeScript-TmLanguage#1071 ·
-
triste 未關閉
難度 5/5 一週以上 新手友好度 5/100
microsoft/TypeScript-TmLanguage#1078 ·
-
難度 3/5 1-2 天 新手友好度 68/100
microsoft/TypeScript-TmLanguage#1076 · 6 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 55/100
microsoft/TypeScript-TmLanguage#1074 · 2 則留言 ·
-
難度 1/5 1-3 小時 新手友好度 58/100
microsoft/TypeScript-TmLanguage#1066 · 1 則留言 ·
查看 microsoft/TypeScript-TmLanguage 的全部 Issue
相似的 Issue
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs 未關閉
難度 2/5 1-3 小時 新手友好度 70/100
-
Crush 未關閉
難度 1/5 1 小時以內 新手友好度 85/100
catppuccin/catppuccin#3125 ·
-
難度 1/5 1 小時以內 新手友好度 90/100
ElementsProject/cln-application#167 · 1 則留言 · 1 個 reaction ·
-
難度 2/5 1-3 小時 新手友好度 75/100
Quantco/pnpm-licenses#17 ·
-
難度 2/5 1-3 小時 新手友好度 75/100