Highlight @example jsdoc body as source code
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 42/100
- Tipo de issue
- Funcionalidade
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- typescript
- Domínio
- tooling
Direção de pesquisa
Revise o VS Code ExampleJsDoc.injection.tmLanguage.json vinculado e o tratamento da gramática de TypeScript/JavaScript do repositório para comentários JSDoc. Confirme como a injection existente separa os asteriscos iniciais do conteúdo da documentação; considera-se concluído quando o corpo de um bloco @example recebe realce de sintaxe de código-fonte.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- TypeScript
- Estrelas
- 471
- Forks
- 150
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de microsoft/TypeScript-TmLanguage
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
microsoft/TypeScript-TmLanguage#1071 ·
-
tristeAberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 5/100
microsoft/TypeScript-TmLanguage#1078 ·
-
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 68/100
microsoft/TypeScript-TmLanguage#1076 · 6 comentários ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 55/100
microsoft/TypeScript-TmLanguage#1074 · 2 comentários ·
-
typescript-basics: fix highlighting for triple-slash reference directives with preserve="true"Aberta
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 58/100
microsoft/TypeScript-TmLanguage#1066 · 1 comentário ·
Todas as issues de microsoft/TypeScript-TmLanguage
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
opengovsg/FormSG#10118 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
ai-driven-qa bug claude
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 75/100
linagora/twake-calendar-frontend#1434 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Add: MBC kr [Geo-blocked]Abertacheck:passed streams:add
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
iptv-org/iptv#52824 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 Meio dia Facilidade para iniciantes 78/100
jaegertracing/jaeger-ui#4512 ·
Mantenedores costumam responder em até 1 dia
-
area:ide documentation enhancement platform:macos platform:vscode
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
anthropics/claude-code#97389 ·
Mantenedores costumam responder em até 1 dia