Hacktoberfest 2026: as issues que os mantenedores marcaram para outubro, abertas e boas para iniciantes. Ver issues do Hacktoberfest

✨ Minimap - Markup comments

Aberta
#313 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
30/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Estagnada
Stack de tecnologia
swift
Domínio
tooling

Direção de pesquisa

Comece localizando a implementação do minimap e o tratamento dos comentários MARK, TODO e FIXME. Revise as alternativas propostas com os maintainers antes de codificar, pois a issue lista vários comportamentos possíveis em vez de um escopo acordado. Considera-se concluído quando o comportamento selecionado para comentários de markup estiver implementado de forma consistente no minimap e verificado visualmente.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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

Linguagem predominante
Swift
Estrelas
720
Forks
162
Nenhum PR com merge em 30d

Guia de contribuição

Nenhum guia de contribuição indexado para este repositório

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de CodeEditApp/CodeEditSourceEditor

Todas as issues de CodeEditApp/CodeEditSourceEditor

Issues semelhantes

Mais issues de Swift

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.