Qual é o objetivo de escrever comentários no Swift como:
// MARK: This is a comment
Quando você também pode fazer:
// This is a comment
O que isso // MARK
alcança?
A sintaxe // MARK:
and // MARK: -
no Swift funciona de forma idêntica à sintaxe #pragma mark
e #pragma mark -
no Objective-C.
Ao usar esta sintaxe (mais // TODO:
e // FIXME:
), você pode obter algumas informações extras para aparecer na barra de salto rápido.
Considere estas poucas linhas de código fonte:
// MARK: A mark comment lives here.
func isPrime(_ value: UInt) -> Bool { return true }
E, para referência, a barra de salto rápido está no topo do Xcode:
Ele existe principalmente para ajudar na navegação rápida dentro do arquivo.
Observe que o traço ( // MARK: -
) faz com que uma boa linha de separação seja exibida. Considere este MARK
comentário:
// MARK: - A mark comment lives here.
A linha separadora cinza mais escura logo acima da opção em negrito nesse menu vem do traço.
Além disso, podemos alcançar essa linha separadora sem um comentário, simplesmente não tendo texto após o traço:
// MARK: -
Como mencionado, // TODO:
e os // FIXME:
comentários também aparecerão aqui.
// MARK: - Prime functions
func isPrime(_ value: UInt) -> Bool {
// TODO: Actually implement the logic for this method
return true
}
func nthPrime(_ value: UInt) -> Int {
// FIXME: Returns incorrect values for some arguments
return 2
}
Clicar em qualquer linha na barra de salto rápido leva você diretamente para essa linha no código-fonte.
// MARK: /Delegate impl. -
para marcar o final de uma seção, ou por que não os dois:// MARK: - Attention! -
MARK simplesmente adiciona uma MARK visual na barra de salto assim:
ex
// MARK: Core Data Stack
fonte
Você sempre pode usar
fonte