Documentação de ajuda rápida gerada automaticamente pelo Xcode 8


85

Entre os novos recursos anunciados no Xcode 8 , podemos ver

"Gerar documentação de ajuda rápida automaticamente":

insira a descrição da imagem aqui

Este é o fim da documentação do código manual como podemos aprender neste artigo do NSHipster ?

Alguém pode descrever os prós e os contras desse novo recurso? Ele substitui ferramentas como o Jazzy ?

Não consegui encontrar mais informações sobre o novo recurso.


@Rob: Alguma ideia de como eu poderia ver como fica sem ter a dor de instalar o Xcode 8 bêta e desinstalá-lo logo em seguida (não autorizado a instalá-lo no mac do meu trabalho)
H4Hugo

É demonstrado em alguns vídeos do WWDC 2016.
Rob


2
Você pode ver uma demonstração no vídeo às 37:00 - mas não consigo fazer com que funcione de verdade! Tentei com swift e obj-c e com várias partes diferentes de uma função selecionada.
Vorlon confuso de

Respostas:


204

Isso se refere ao recurso Xcode 8 (e posterior), onde você pode selecionar um método como este:

func foo(bar: Int) -> String { ... }

... e então pressione + option+ /(ou escolha “Estrutura” »“ Adicionar documentação ”do menu“ Editor ”do Xcode) e ele irá gerar o seguinte modelo de comentários para você:

/// <#Description#>
///
/// - parameter bar: <#bar description#>
///
/// - returns: <#return value description#>

Isso apenas facilita a redação de documentação para Ajuda Rápida.


Observe que, embora esse comportamento tenha mudado um pouco com o tempo, o Xcode pode ser específico sobre onde o cursor deve estar quando você tenta fazer isso. Por exemplo, o cursor deve estar em algum lugar no nome da função, foono meu exemplo acima, para que isso funcione. Ou apenas clique duas vezes no nome da função e pressione + option+/


1
você pode fazer funcionar? Eu não posso. Se você puder; o que você está selecionando quando usa o comando? Eu tentei quase todas as opções ...
Vorlon confuso

2
Apenas coloco meu cursor em algum lugar no nome do método e pressiono comando + opção + "/" (além de ter escolhido "Editor" - "Estrutura" - "Adicionar documentação") no Xcode 8 e funciona bem. O único problema que encontrei até agora é que parece ser confundido com @IBActionmétodos. Mas funciona bem com Objective-C e Swift. Se você ainda está tendo problemas e tentou o procedimento usual de reiniciar o Xcode e / ou reinicializar sua máquina, você pode apenas postar um relatório de bug neste software beta.
Rob

2
Acabei de tentar reiniciar, mas ainda sem alegria. Eu enviei um relatório de bug.
Vorlon confuso de

5
Na verdade, está funcionando a partir do Xcode 8 beta 1, mas se você estiver usando o El Capitan, você precisa iniciar o Xcode, deixá-lo instalar os componentes do sistema necessários e, em seguida, executar sudo /usr/libexec/xpccachectlno Terminal e reiniciar seu Mac antes que ele ou qualquer outra extensão Xcode irá trabalhos. Consulte as notas de versão do Xcode 8.
Chris Hanson

1
Acho que funciona esporadicamente. Às vezes funciona muito bem e outras vezes nem um pouco. Nem descobri por quê. Francamente, quando funciona, acho que as coisas que ele gera automaticamente são bastante esparsas (nome do método na Descrição?). Para vocês que funciona sem problemas, demais. Para alguns de nós, é esporádico ou simplesmente não funciona.
Lloyd Sargent

7

Isso provavelmente está relacionado ao fato de que TODAS as teclas de atalho com um '/' não funcionam na compilação atual do XCode 8, se o seu teclado exigir que você pressione shift para obtê-lo.

Ou seja, no teclado alemão o '/' é shift + 7, pressionando alt + cmd + shift-7 não faz nada. Se você atribuir, por exemplo, cmd + shift + opt + d, funcionará perfeitamente.

O atalho '///', que infelizmente também não funciona agora, provavelmente se deve ao antigo plugin do XCode VVDocumenter, que usava exatamente esse atalho.

Excelente recurso, péssimo controle de qualidade do lado da Apple.


Havia esse bug no Xcode 8 beta, mas ele foi corrigido na versão lançada.
Eric Aya,

8A218a é a versão lançada - e o atalho de comentário funciona novamente para mim (não funcionava nos betas).
Eric Aya

Você está em um layout de teclado, onde obtém '/' sem usar shift?
Klaus Busse

Sim, tenho dois teclados, um francês Azerty com "/" em cima de ":" e um americano Qwerty. Ambos funcionam bem para o atalho de comentário.
Eric Aya,

Bem, é intermitente para mim (teclado americano).
Lloyd Sargent,
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.