Omnigraffle howto ?

laudemalaudema Membre
juin 2013 modifié dans API AppKit #1

Bonjour,


 


Il y a peu Ali suggérait d'utiliser Omnigraffle pour faire une petite introspection d'un projet. Et effectivement Omnigraffle accepte d'ouvrir un projet Xcode. Mais tout ce qu'il donne c'est les headers de chaque classe.


Réponses

  • AliGatorAliGator Membre, Modérateur

    Le test que tu as fait avec OmniGraffle tu l'as fait sur un projet d'exemple sans doute un peu simple, avec tes classes qui n'ont pas trop de relations de composition ou autre entre elles, ni trop d'héritage... forcément je comprend que le résultat du coup puisse être décevant


  • Merci beaucoup, c'est effectivement plus "parlant" sur un gros projet. Mais mes classes utilisent peu la composition ni l'héritage du coup j'y trouve peu d'intérêt par rapport à  ré-ouvrir mon projet avec Xcode 3 et utiliser "Quick Model" qui n'était pas si mal. Dommage qu'il ait été abandonné.


    Finalement papier et crayons ont peut être encore de beaux jours devant eux :)


  • AliGatorAliGator Membre, Modérateur

    Oui c'est dommage que le module QuickModel n'existe plus...


     


    D'ailleurs j'avais pensé à  un moment rechercher s'il n'existait pas une appli sur le net reprenant le concept, c'est à  dire faire des diagrammes de classe UML comme ça, intégrés à  Cocoa (= proposant les classes Cocoa de base dans les types) et permettant de générer du code (voire se synchroniser avec le code)... Et si ça existait pas, pourquoi pas monter un projet pour le créer... mais ça n'a jamais trop abouti...


  • ça semble beaucoup de travail aussi pour un bénéfice assez maigre probablement.


    Je viens de découvrir Doxygen dans ma tentative d'y voir plus clair dans les relations entre mes classes, ça semble efficace et d'une qualité qu'on ne trouve pas toujours dans l'open-source !


    J'irais quand même sur bugreporter demander le retour du "Quick Model" : l'union fait la force :)


  • AliGatorAliGator Membre, Modérateur
    Nous plutôt que d'utiliser Doxygen, on utilise appledoc

    C'est exactement le même principe, mais c'est un outil permettant de générer de la doc au look Apple directement (outil pas fait par Apple contrairement à  ce que le nom peut laisser penser, le "apple" est juste parce que c'est look Apple)

    Avantage, c'est parfaitement intégré à  des outils comme CocoaPods. Par exemple tous nos composants ont de la doc "à  la Doxygen" dans le code pour documenter leur API, et quand on crée un nouveau projet et qu'on fait un "pod install" pour importer nos composants, cela installe automatiquement dans l'Organizer Xcode la doc de tous les composants qu'on va utiliser !
  • laudemalaudema Membre
    juin 2013 modifié #7

    appledoc permet de faire de très belles documentations comme celles d'Apple mais ce que je cherche c'est un diagramme de mes objets. Je ne l'ai pas utilisé mais j'ai regardé les exemples qu'il donne et c'est vrai que ça fait une belle documentation, claire, nette et dans un format bien connu.


    Doxygen [peut] génère[r] des graphes, et c'est ce que je recherchais, en particulier comment les objets s'articulent entre eux et comment les appels de méthodes s'enchaà®nent. ça et l'usage de __deprecated devrait me permette de nettoyer mon code des branches mortes que je n'ai pas toujours pris le temps d'élaguer quand j'ai ré-écrit certains pans de mon projet.


    Ce qui n'enlève rien aux qualités de appledoc qui me semble en effet un très bon outil pour superbement documenter son code, à  son usage ou à  l'usage d'autres développeurs, mais ça n'est simplement pas mon but aujourd'hui.


Connectez-vous ou Inscrivez-vous pour répondre.