microsoft / microsoft/TypeScript-TmLanguage
Highlight @example jsdoc body as source code
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 471
- Forks
- 149
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
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
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Revisa el archivo vinculado VS Code ExampleJsDoc.injection.tmLanguage.json y el manejo de la gramática de TypeScript/JavaScript del repositorio para los comentarios JSDoc. Confirma cómo la inyección existente separa los asteriscos iniciales del contenido de la documentación; se considera terminado cuando el cuerpo de un bloque @example recibe resaltado de sintaxis de código fuente.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- tooling
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100