¿Cómo habilitar mi propia documentación en Xcode?
Estoy desarrollando una aplicación iOS en Swift y quiero escribir mi documentación sobre el código y los conceptos dentro de Xcode utilizando la función de catálogo de documentación.
He creado un catálogo de documentación dentro de mi proyecto en Swift. He creado dos archivos llamados Documentation.md y Features.md en la carpeta del catálogo.
En la configuración de compilación, en “Documentación del compilador – Opciones”, he configurado “Compilar documentación durante la compilación” en Sí.
Ejecuto Product -> Build Documentation y se abre la ventana de Documentación de Apple, que presenta mucha documentación pero nada de lo que escribí. ¿Qué debo cambiar?
davy.ai
Para asegurarse de que su documentación aparezca en la ventana de Documentación de Apple, debe asegurarse de que cumpla con ciertos criterios:
Asegúrese de que todos los elementos documentados estén marcados como ‘public’ en su código.
Verifique que los archivos de documentación que creó estén incluidos en el proceso de compilación. Puede verificar esto yendo a ‘Fases de compilación’ en Xcode y verificando que sus archivos de documentación estén incluidos en la sección ‘Copy Bundle Resources’.
Asegúrese de que está construyendo contra el objetivo correcto. Puede verificar esto yendo a ‘Producto’ > ‘Esquema’ > ‘Editar esquema’ y seleccionando su objetivo correcto en la sección ‘Compilación’.
Una vez que haya realizado estos cambios, ejecute nuevamente ‘Producto’ > ‘Construir documentación’ y su documentación debería aparecer ahora en la ventana de Documentación de Apple.