Documentación de ayuda rápida generada automáticamente por Xcode 8

85

Entre las nuevas funciones anunciadas en Xcode 8 , podemos ver

"Generar automáticamente documentación de ayuda rápida":

ingrese la descripción de la imagen aquí

¿Es este el final de la documentación del código manual como podemos aprender en este artículo de NSHipster ?

¿Alguien puede describir los pros y los contras de esta nueva función? ¿Reemplaza herramientas como Jazzy ?

No pude encontrar más información sobre la nueva función.

H4Hugo
fuente
@Rob: Alguna idea de cómo podría ver cómo se ve sin tener el dolor de instalar Xcode 8 bêta y desinstalarlo inmediatamente después (no estoy autorizado para instalarlo en la Mac de mi trabajo)
H4Hugo
Se demuestra en algunos videos de la WWDC 2016.
Rob
2
Puede ver una demostración en el video a las 37:00, ¡sin embargo, no puedo hacer que funcione! Lo he intentado con swift y obj-c y con varias partes diferentes de una función seleccionada.
Confused Vorlon

Respuestas:

203

Esto se refiere a la función Xcode 8 (y posterior), donde puede seleccionar un método como este:

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

... y luego presione + option+ /(o elija “Estructura” »“ Agregar documentación ”del menú“ Editor ”de Xcode) y generará la siguiente plantilla de comentarios para usted:

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

Simplemente facilita la redacción de documentación para la Ayuda rápida.


Tenga en cuenta que, aunque este comportamiento ha cambiado un poco con el tiempo, Xcode puede ser particular sobre dónde debe estar el cursor cuando intenta hacer esto. Por ejemplo, el cursor tiene que estar en algún lugar del nombre de la función, fooen mi ejemplo anterior, para que esto funcione. O simplemente haga doble clic en el nombre de la función y luego presione + option+/

Robar
fuente
1
¿Puedes hacer que funcione? No puedo. Si puedes; ¿Qué estás seleccionando cuando usas el comando? He probado casi todas las opciones ...
Confused Vorlon
2
Simplemente coloco el cursor en algún lugar del nombre del método y luego presiono comando + opción + "/" (además de haber elegido "Editor" - "Estructura" - "Agregar documentación") en Xcode 8 y funciona bien. El único problema que he encontrado hasta ahora es que parece confundirse con @IBActionmétodos. Pero funciona bien con Objective-C y Swift. Si todavía tiene problemas y ha probado el procedimiento poco convincente habitual de reiniciar Xcode y / o reiniciar su máquina, es posible que solo desee publicar un informe de error en este software beta.
Rob
2
Intenté reiniciar, pero todavía no me alegro. He enviado un informe de error.
Confused Vorlon
5
En realidad, está funcionando a partir de Xcode 8 beta 1, pero si está usando El Capitan, debe iniciar Xcode, dejar que instale los componentes requeridos del sistema, y ​​luego ejecutar sudo /usr/libexec/xpccachectlen Terminal y reiniciar su Mac antes de que lo haga o cualquier otra extensión de Xcode. trabajo. Consulte las notas de la versión de Xcode 8.
Chris Hanson
1
Encuentro que funciona esporádicamente. A veces funciona muy bien y otras no en absoluto. Tampoco he descubierto por qué. Francamente, cuando funciona, encuentro que las cosas que genera automáticamente son bastante escasas (¿nombre del método en la Descripción?). Para aquellos de ustedes que funciona sin problemas, increíble. Para algunos de nosotros, es esporádico o simplemente no funciona.
Lloyd Sargent
7

Lo más probable es que esto esté relacionado con el hecho de que TODAS las teclas de acceso rápido con '/' no funcionan en la versión actual de XCode 8, si su teclado requiere presionar Mayús para obtenerlo.

Es decir, en el teclado alemán, la '/' es shift + 7, presionar alt + cmd + shift-7 no hace nada. Si asigna, por ejemplo, cmd + shift + opt + d, funciona bien.

El acceso directo '///', que lamentablemente tampoco funciona en este momento, probablemente se deba al antiguo complemento de XCode VVDocumenter, que utilizaba exactamente este acceso directo.

Gran característica, pésimo control de calidad en el lado de Apple.

Klaus Busse
fuente
Hubo este error en Xcode 8 beta, pero se corrigió en la versión de lanzamiento.
Eric Aya
8A218a es la versión publicada, y el atajo de comentarios vuelve a funcionar para mí (no en las versiones beta).
Eric Aya
¿Está en una distribución de teclado, donde obtiene '/' sin usar shift?
Klaus Busse
Sí, tengo dos teclados, uno francés Azerty con "/" encima de ":" y uno americano Qwerty. Ambos funcionan bien para el atajo de comentarios.
Eric Aya
Bueno, es intermitente para mí (teclado americano).
Lloyd Sargent