Repte: crear documentació increïble – Descobrir

Icona per a paquets ràpids en una caixa marró amb una icona ràpida

Exploreu les noves funcions de documentació de Xcode i apreneu a afegir documentació al vostre propi marc o paquet o al vostre projecte de codi obert preferit. Per a aquest repte, creeu documentació per al vostre propi marc o paquet (o el vostre projecte de codi obert preferit). Utilitzeu Xcode 13 per crear documentació a partir dels comentaris de capçalera del vostre marc Swift i afegir un catàleg de documentació per organitzar el vostre contingut.

Comenceu el repte

Obriu el projecte a Xcode i comenceu a afegir comentaris a la documentació del vostre origen mitjançant la sintaxi de la casella de selecció Swift DocC. DocC utilitza els comentaris que escriviu al codi font com a contingut de les pàgines de documentació que genera. Com a mínim, afegiu comentaris a la documentació principal als símbols públics del marc per utilitzar-los com a documents com a resums o resums d’una frase. Aquí teniu un exemple:





public struct Sloth {
    
    public var species: Species

Quan hàgiu acabat la documentació, trieu Producte> Crea documentació per generar els vostres documents de referència ràpida de sortida i la finestra Documentació per a desenvolupadors.

Finestra de documentació Xcode que mostra informació sobre els perezosos

Necessiteu ajuda per redactar o elaborar la vostra documentació? Podeu compartir el vostre progrés als fòrums de desenvolupadors.

Visiteu els fòrums de desenvolupadors d’Apple

Recursos

Documenta un marc o paquet ràpid

Llegiu els Termes i condicions generals dels reptes de la WWDC21

Add a Comment

Your email address will not be published. Required fields are marked *