Highlight @example jsdoc body as source code
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 42/100
- Issue-Typ
- Feature
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- typescript
- Bereich
- tooling
Rechercherichtung
Überprüfe die verlinkte VS Code ExampleJsDoc.injection.tmLanguage.json und die Verarbeitung der TypeScript/JavaScript-Grammatik für JSDoc-Kommentare im Repository. Bestätige, wie die bestehende Injection führende Sternchen vom Dokumentationsinhalt trennt; als abgeschlossen gilt die Aufgabe, wenn der Body eines @example-Blocks Syntaxhervorhebung für Quellcode erhält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
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
- Vorherrschende Sprache
- TypeScript
- Sterne
- 471
- Forks
- 149
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus microsoft/TypeScript-TmLanguage
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 72/100
microsoft/TypeScript-TmLanguage#1071 ·
-
triste Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 5/100
microsoft/TypeScript-TmLanguage#1078 ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
microsoft/TypeScript-TmLanguage#1076 · 6 Kommentare ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 55/100
microsoft/TypeScript-TmLanguage#1074 · 2 Kommentare ·
-
typescript-basics: fix highlighting for triple-slash reference directives with preserve="true" Offen
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 58/100
microsoft/TypeScript-TmLanguage#1066 · 1 Kommentar ·
Alle Issues in microsoft/TypeScript-TmLanguage
Ähnliche Issues
-
bug(cli): hapi doctor inline-media prints a fabricated B:\ helper-script path in packaged installs Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
-
Crush Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
catppuccin/catppuccin#3125 ·
-
Add a SECURITY.md Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
ElementsProject/cln-application#167 · 1 Kommentar · 1 Reaktion ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Quantco/pnpm-licenses#17 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100