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