✨ Minimap - Markup comments
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Anfängerfreundlichkeit
- 30/100
Rechercherichtung
Beginne damit, die minimap-Implementierung und die Behandlung von MARK-, TODO- und FIXME-Kommentaren zu finden. Besprich die vorgeschlagenen Alternativen vor dem Codieren mit den Maintainer:innen, da das Issue mehrere mögliche Verhaltensweisen statt eines vereinbarten Umfangs aufführt. Als abgeschlossen gilt die Aufgabe, wenn das ausgewählte Markup-Kommentarverhalten konsistent in der minimap implementiert und visuell überprüft wurde.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Description
In many code editors(like xcode, vscode etc) the minimap provides the ability to also function as a table of contents.
That is done by using the following keywords:
//MARK: Regular Mark
//MARK: - Mark with line seperator
//TODO: A todo list item.
//TODO: - A todo list item with line seperator.
//FIXME: A fixme item
//FIXME: - A fixme item with line seperator.
This picture shows how it is implemented in xcode.
Additional Context
As can be seen in the picture above, the xcode minimap doesn't differentiate between TODO and FIXME. for both it does show a line separator.
I would suggest a few changes to xcode's implementation of todo and fixme.
- Both fixme and todo are not needed. just todo is good enough.
- It might be beneficial for todos to be shown in the minimap, not just as a line. Perhaps with a smaller font or just the word todo, showing there is a todo at that place.
- I don't think a line separator is needed for todo's
- It might be nice to have one of the left side panels to be a list of all todo's. If there aren't any in the code, perhaps it can be a built-in todo list (which is currently, I believe, way out of scope and for sure a feature on its own.)
Besides the line separator there is no difference between the 2 Mark's.
Perhaps it can be considered to make the mark without line separator regular font and slightly smaller, and to keep the line-separated mark bold and large.
Screenshots
No response
- Vorherrschende Sprache
- Swift
- Sterne
- 720
- Forks
- 162
- 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 CodeEditApp/CodeEditSourceEditor
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100
CodeEditApp/CodeEditSourceEditor#377 · 1 Kommentar ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 76/100
CodeEditApp/CodeEditSourceEditor#376 · 1 Kommentar ·
-
Schwierigkeit 1/5 1-3 Stunden Anfängerfreundlichkeit 68/100
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 68/100
CodeEditApp/CodeEditSourceEditor#378 · 1 Kommentar ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 32/100
Alle Issues in CodeEditApp/CodeEditSourceEditor
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
-
enhancement
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
Cocoanetics/SwiftACP#52 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
storyblok/storyblok-swift#12 ·
-
bug yapback
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100