Bienvenido, me llamo Miguel y para hoy les traigo este nuevo tutorial.
Cambiemos el encabezado del archivo predeterminado proporcionado por Xcode
Todo el mundo está acostumbrado al encabezado del archivo que se proporciona de forma predeterminada en Xcode y rara vez es necesario cambiarlo. ¿Por qué alguien tendría que cambiarlo de todos modos?
Por otro lado … ¿por qué está ahí de todos modos? ¿Proporciona alguna información útil?
// // FILE_NAME.swift // MODULE_NAME // // Created by AUTHOR on DD/MM/yyyy. // Copyright © yyyy ORGANIZATION. All rights reserved. //
El encabezado predeterminado contiene el nombre de un archivo que en realidad no importa, pero puede resultar molesto cuando refactoriza su código o simplemente cambia el nombre de su archivo, pero no actualiza el encabezado automáticamente.
No nos gusta la inconsistencia, ¿no sería mejor si elimináramos esta línea de ahí?
Lo mismo ocurre con el nombre del módulo, podríamos cambiarle el nombre en el futuro y el encabezado permanecerá desactualizado.
Un autor puede ser bastante útil, pero ¿realmente importa quién creó el archivo primero? No lo creo. De todos modos, el archivo puede cambiar por completo durante el desarrollo y es posible que no haya ni una sola línea de código que el creador inicial haya escrito de todos modos.
Además, una fecha usa el formato de fecha preferido del creador, que puede ser inconsistente entre todos los desarrolladores del proyecto.
A veces, especialmente si trabaja como desarrollador independiente, ni siquiera podemos usar el predeterminado, ya que nuestro cliente nos obliga a usar un conjunto de datos diferente y lo único que podemos cambiar fácilmente es el nombre de la organización, a través del panel de inspectores ( el de la derecha en Xcode).
Personas que provienen de diferentes plataformas, como Android o Aleteo Podría sorprenderse de que Xcode agregue un encabezado de este tipo de forma predeterminada, ya que no es una práctica común allí (corríjame si me equivoco, por favor) para agregar un encabezado.
Plantilla personalizada
Ha pasado mucho tiempo desde que fue posible proporcionar una plantilla personalizada para un encabezado, ya que se agregó en Xcode 9. Sin embargo, nunca tuve la necesidad de cambiar eso hasta ahora.
El cliente quiere que elimine todo excepto la Copyrightlínea y, dado que será un proyecto bastante grande, no quiero (y probablemente no lo haré) recordar arreglar el encabezado cada vez que cree un nuevo archivo.
Para comenzar a usar una plantilla de encabezado personalizada, necesitamos crear un IDETemplteMacros.plistarchivo en una de las cinco ubicaciones disponibles:
- Proyecto de datos del usuario – no será compartida entre los miembros del proyecto:
<ProjectName>.xcodeproj/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist. - Proyecto compartido de datos – serán compartidos con todos los que trabajan en el mismo proyecto:
<ProjectName>.xcodeproj/xcshareddata/IDETemplateMacros.plist. - Datos de los usuarios del espacio de trabajo – Igual que el anterior, sólo por todo un espacio de trabajo:
<WorkspaceName>.xcworkspace/xcuserdata/[username].xcuserdatad/IDETemplateMacros.plist. - Espacio de trabajo compartido de datos – Igual que el anterior, sólo por todo un espacio de trabajo:
<WorkspaceName>.xcworkspace/xcshareddata/IDETemplateMacros.plist. - Xcode usuario de datos – se utilizará para todos los proyectos, no se comparte con otros desarrolladores:
~/Library/Developer/Xcode/UserData/IDETemplateMacros.plist.
En la documentación oficial de Xcode , puede encontrar una lista de todas las macros disponibles que se pueden usar dentro de su encabezado personalizado.
Por ejemplo, si quisiéramos agregar un texto de derechos de autor predeterminado, necesitaríamos incluir la macro adecuada. A continuación, puede encontrar una muestra IDETemplteMacros.plistcon un encabezado de archivo personalizado.
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>FILEHEADER</key>
<string>
// OrdinaryCoding.com
// ___COPYRIGHT___
//
// Follow me on Twitter: @artrmzx
//</string>
</dict>
</plist>
La primera línea está vacía ya que Xcode agrega automáticamente una marca de comentario a la primera. Una vez que agregue un archivo plist en una de las ubicaciones anteriores, cada archivo que cree ahora tendrá su nuevo encabezado de archivo personalizado:
Conclusión
Como puede ver, es bastante sencillo personalizar los encabezados de sus archivos. ¿Tiene algún encabezado preferido que usa habitualmente o le gustaría usar?
Creo que a algunas personas les encantaría eliminarlo por completo, aunque no hay forma de proporcionar una cadena vacía ya que Xcode agrega la marca de comentario //a la primera línea de forma predeterminada.
Gracias por leer.
Añadir comentario