Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

✨ Minimap - Markup comments

未關閉
#313 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
30/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
停滯
技術堆疊
swift
領域
tooling

研究方向

首先定位 minimap 的實作,以及對 MARK、TODO 和 FIXME 註解的處理。在開始編碼前先與維護者檢視提議的替代方案,因為該 issue 列出了幾種可能的行為,而不是一個已達成共識的範圍。完成的標準是:選定的 markup 註解行為已在 minimap 中一致實作,並經過目視驗證。

由索引模型根據 Issue 內容生成。

描述

enhancement
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.

Image

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.

  1. Both fixme and todo are not needed. just todo is good enough.
  2. 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.
  3. I don't think a line separator is needed for todo's
  4. 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

主要語言
Swift
星號
720
分支
162
PR 合併指標
30 天內沒有已合併 PR

貢獻指南

這個儲存庫沒有索引到貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

CodeEditApp/CodeEditSourceEditor 的其他 Issue

查看 CodeEditApp/CodeEditSourceEditor 的全部 Issue

相似的 Issue

更多 Swift Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。