Marcado de documentación de Swift

Sobre este libro

«Por muy claro y bien escrito que esté, el código desnudo nunca logra documentarse por sí solo. Siempre queda espacio para los comentarios, ya sea la explicación integrada de los puntos clave del diseño o la anotación formal de las declaraciones públicas. Casi todos los lenguajes de programación modernos, incluido Swift, cuentan con algún tipo de sistema de comentarios estructurado que documenta las API para quienes las utilizan. El sistema de documentación estructurada de Swift combina palabras clave propias del lenguaje con sintaxis Markdown para crear una herramienta de anotación sencilla y fácil de usar. Al basarse en esta tecnología, estándar en el sector, Apple abre su sistema de documentación estructurada a una generación completamente nueva de desarrolladores, que solo necesitan la formación mínima indispensable para ponerse al día. Este breve libro te introduce en el sistema de marcado de documentación de Swift mediante ejemplos sencillos e ilustrados, acompañados de abundantes reflexiones sobre buenas prácticas. Descubrirás los componentes que conforman el sistema de comentarios estructurado de Swift y aprenderás a integrarlos de la mejor forma posible en tu propio código. En buena medida, he elaborado este material a partir de ejemplos de la biblioteca estándar de Swift, notas de publicación y la ingeniería inversa de especificaciones de hojas de estilo extensibles. Aunque he intentado incluir una lista completa de tokens válidos, me he centrado en complementar los detalles esenciales con una reflexión cuidadosa sobre buenas prácticas que resistan el paso del tiempo, incluso cuando Apple siga actualizando el sistema. Espero que este libro sea una adición útil y valiosa para tu biblioteca de recursos de desarrollo. He disfrutado muchísimo escribiéndolo, y ojalá tú disfrutes igual o más al leerlo. Mil gracias por hacerte con un ejemplar. -- Erica Sadun Lo que dicen los primeros lectores: «Ojalá todas las líneas de #swiftlang que lea en el futuro hayan sido escritas por alguien que haya leído el [libro] formidable de @ericasadun» -- Mark Engle, @_markengle «Acabo de comprar el libro sobre marcado de documentación de #swiftlang de @ericasadun. Es genial para quienes desarrollan en Swift» -- @Kametrixom «El nuevo libro de Erica Sadun, «Swift Documentation Markup, an Illustrated Tour», no solo explica la importancia de la documentación, sino que también com