Swift: equivalente de advertencia

¿Swift tiene un equivalente de # advertencia? Simplemente se usa para mostrar una advertencia en la propia GUI de Xcode

También me interesa saber si hay un #error equivalente.

Apple ha dicho que la marca #pragma llegará pronto, posiblemente podría ser lo mismo con esto.

En el futuro, los desarrolladores de Apple pueden lanzar un //WARNING:hito o proporcionar la funcionalidad para otro hito con nombre.

Sin embargo, para invocar esta funcionalidad con Swift en Xcode hoy, puede hacer lo siguiente, tal como lo describen Ben Dodson y Jeffrey Sambells:

Agregue un nuevo script de ejecución a la pestaña de fases de compilación de su destino (configuración del proyecto> fases de compilación> '+'> nueva fase de script de ejecución) y pegue el siguiente código en el cuadro vacío:

TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"

Esto obligará a Xcode para marcar un aviso en tiempo de compilación para cualquier // TODO:o // FIXME:comentario que de marcado.

Alternativamente, puede modificar TAGS con una etiqueta personalizada: TAGS="WARNING:"en el código anterior, que mantendría el comportamiento predeterminado para TODO y FIXME y generaría una advertencia de tiempo de compilación en cualquier comentario marcado como // WARNING:.

http://bendodson.com/weblog/2014/10/02/showing-todo-as-warning-in-swift-xcode-project/ http://jeffreysambells.com/2013/01/31/generate-xcode- advertencias de todo-comentarios

EDITAR: 18/11/14

@ david-h planteó un buen punto en su comentario. Si solo desea generar estas advertencias en una configuración de compilación específica, puede hacer lo siguiente:

if [ "${CONFIGURATION}" = "Debug" ]; then
TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"
fi

Alternativamente, puede usar "Release" en lugar de "Debug" para apuntar solo a las compilaciones de producción.

Editar

A partir de Swift 4.2, el soporte de nivel de idioma está disponible tanto para advertencias de compilación como para errores.

#warning("Warning description")
#error("Throws a build error")

Respuesta original

Rápido, sucio y tan elegante y simple al mismo tiempo.

// Description of what you need to fix

var FIX_ME__🛠🛠🛠: AnyObject

Lanza una advertencia de que 'FIX_ME__🛠🛠🛠' nunca se usó.

Puede agregar emoticones al nombre de la variable si lo desea ... A menudo uso 😱 y 🛠, para algo que realmente necesita reparación, incluso consideraría 💩. Se puede reemplazar FIX_ME__con lo que quieras: ALGORITHM_NEEDS_REVIEW, BugID_148o JOHNNY_YOU_BROKE_THISson algunos ejemplos.

Rápido, sin configuración, conciso, y los emoticones pueden incluso agregar humor / personalidad a su código. A veces la solución más simple es la mejor solución.

Actualización posterior a WWDC 2018

Comenzando con Xcode 10 y Swift 4.2, ahora podrá volver a usarlo #warningasí:

#warning("TODO: Clean up this code after testing")

¡Esto aparecerá como una advertencia en Xcode tal como se esperaba!

Esto funciona incluso en combinación con #ifcontroles, por ejemplo, lo siguiente solo mostrará una advertencia si su plataforma de destino es iOS:

#if os(iOS)
    #warning("this code is untested in iOS")
#endif

También hay #errorsi quieres que tu construcción falle.

Respuesta previa a WWDC 2018

En Swift usando XCode 6, puede usar diferentes tipos de puntos de referencia para diferentes propósitos. Esto es lo que Apple dice al respecto:

Xcode ahora admite // MARK :, // TODO: y // FIXME: puntos de referencia para anotar su código y enumerarlos en la barra de salto.

Entonces, para configurar una advertencia con una descripción, usaría algo como esto:

//TODO: Clean up this code after testing

Si solo desea establecer una marca corta (suponiendo que recordará qué hacer), use esto:

//FIXME

EDITAR: Sin embargo, estos puntos de referencia solo aparecen en la barra de salto de XCode, que puede no ser lo que desea y lo que uno esperaría, especialmente de las marcas // TODO: y // FIXME. He archivado un radar sobre eso: # 17776817. Esperemos que Apple agregue esto en las próximas versiones en XCode 6.

SOLUCIÓN (EDIT 2): Si instala el Swift Linter través Homebrew (correr brew install swiftlintdespués de una brew update) y añadir el script de construcción sugerido a su proyecto, a continuación, podrás ver todos tus TODOe FIXMEhitos aparecen como advertencias dentro de Xcode. SwiftLint incluso agregará más advertencias / errores que puede configurar para satisfacer sus necesidades. ¡Solo puedo recomendarle usar SwiftLint y resuelve este problema de una manera excelente!

Todavía no agregado por el equipo de Apple todavía. Lo que decidí hacer es probablemente una trampa, pero al menos me muestra un mensaje FIXME. Entonces, lo que hago es declarar la función FIXME () en el archivo Swift:

@availability(iOS, deprecated=1.0, message="I'm not deprecated, please ***FIXME**")
func FIXME()
{
}

y cuando lo llamo desde cualquier otra función, muestra una advertencia, por ejemplo

override func tableView(tableView: UITableView, numberOfRowsInSection section: Int) -> Int
{
    FIXME()     // Incomplete method implementation.
    return 0
}

Para uso Swift 2

@available(iOS, deprecated=1.0, message="I'm not deprecated, please ***FIXME**")

Mira este artículo .

Puede escribir su propio script que resaltará todas las etiquetas.

TAGS="TODO:|FIXME:"
ERRORTAG="ERROR:"
find "${SRCROOT}" \( -name "*.h" -or -name "*.m" -or -name "*.swift" \) -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$|($ERRORTAG).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/" | perl -p -e "s/($ERRORTAG)/ error: \$1/"

Esto da como resultado:

Como alternativa, si desea que aparezca algo en el panel de advertencias, puede escribir algo como:

if (false){
   var x = 2;
}

Realmente no puede aparecer ningún texto, pero al menos es un marcador más visible, especialmente si tiende a tratar (la mayoría) de las advertencias como errores.

Me propuse y implementado esta característica, y se venderá con Swift 4.2. Puede usarlo ahora descargando la mastercadena de herramientas en swift.org .

#if os(macOS)
  #error("macOS is not supported")
#endif
#warning("finish this")

Un CocoaPod que estaba usando tenía .swiftsu nombre, por lo que se devolvió un directorio, lo que provocó que Kyle se bloqueara. Agregar -type fal findcomando corrige ese problema al mirar solo los archivos que coinciden en *.swiftlugar de devolver directorios que coinciden con el patrón.

Código final que usé:

TAGS="TODO:|FIXME:"
echo "searching ${SRCROOT} for ${TAGS}"
find "${SRCROOT}" \( -name "*.swift" \) -type f -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"

Si no desea ajustar la configuración de su compilación, otro remedio casero simple es colocar un marcador de posición de editor delante del comentario:

<#todo#>// stop and fixme!

Cuando construye, obtiene un error de "Marcador de posición del editor en el archivo fuente", pero a diferencia de la solución de Jordan, no hay ningún error en vivo que lo moleste mientras escribe:

Después de mucha búsqueda y anhelo, estoy convencido de que no existe tal entidad. Todavía tengo esperanzas con las últimas notas de lanzamiento de Xcode que mencionan la falta continua de un mecanismo de marca #pragma, también pueden aparecer #warning y #error.

Como comentario aparte, recomiendo presentar un radar con Apple en bugreport.apple.com para agregar esta funcionalidad (puede engañar a 17702491).

Escribimos una herramienta configurable que le permite poner advertencias y errores en Xcode Issue Navigator en función de la etiqueta de comentario y la configuración de compilación: https://github.com/doubleencore/XcodeIssueGenerator

Instalarlo:

brew tap doubleencore/tap
brew install xcodeissuegenerator

Luego ponga una línea en una Fase de Ejecución del Script de Ejecución

# Mark WARNINGs, SERIOUSs, and TODOs as warnings in DEBUG builds excluding the Vendor and Third Party directories.
XcodeIssueGenerator -b DEBUG -w "WARNING, SERIOUS, TODO" -x "Vendor/, Third Party/"

Aquí hay un artículo que describe cómo lo usamos.

Es posible que llegue tarde a la fiesta con Xcode 10 que admite errores y advertencias, pero simplemente poniendo una Cadena:

"Need to finish implementing this"

generará una advertencia: String literal is unusedcon la función de autocompletar aún funcionando y el proyecto aún compilándose

Mi respuesta no es satisfacer su pregunta, pero si quiere algo fácil, puede usar este complemento de alcatraz que funciona en todos los proyectos sin ninguna preparación adicional. Solo haz lo siguiente:

1) install Alcatraz (Nice package manager for Xcode Plug-ins) by entering this line in terminal: 
curl -fsSL https://raw.githubusercontent.com/supermarin/Alcatraz/deploy/Scripts/install.sh | sh
2) Then restart Xcode and on it launch agree to install all bundles not included in Xcode
3) In Xcode select menu item -> Window -> Package manager -> type in search panel XTodo and press install
4) Relaunch Xcode and again agree to install additional bundles
5) From now press Ctrl + T and you will see all Tags in nice window

También tiene preferencias para agregar nuevas etiquetas

Ventaja de este fragmento: no muestra advertencias de Pods:

if [ "${CONFIGURATION}" = "DEBUG" ]; then 
    TAGS="TODO:|FIXME:|WARNING:|warning:" find "." \( -name "*.swift" \) -not -path "./Pods/*" -print0 | xargs -0 egrep --with-filename --line-number --only-matching "($TAGS).*\$" | perl -p -e "s/($TAGS)/ warning: \$1/"
fi

Cómo instalar: