✨ Minimap - Markup comments

Đang mở
#313 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
30/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
swift
Lĩnh vực
tooling

Hướng nghiên cứu

Bắt đầu bằng cách xác định phần triển khai minimap và cách xử lý các comment MARK, TODO và FIXME. Hãy xem xét các phương án được đề xuất cùng với các maintainer trước khi viết code, vì issue liệt kê một số hành vi có thể có thay vì một phạm vi đã được thống nhất. Được xem là hoàn tất khi hành vi đã chọn đối với comment markup được triển khai nhất quán trong minimap và được xác minh bằng mắt.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Swift
Star
720
Fork
162
Không có pull request nào được merge trong 30 ngày

Hướng dẫn đóng góp

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của CodeEditApp/CodeEditSourceEditor

Tất cả issue của CodeEditApp/CodeEditSourceEditor

Issue tương tự

Thêm issue về Swift

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.