Czy istnieje ogólnie przyjęty generator dokumentacji dla Objective-C (podobny do RDoc dla Ruby)? Widziałem Doxygen i ObjcDoc i zastanawiam się, które jest najczęściej używane.Generator dokumentacji dla Objective-C?
Doxygen jest prawdopodobnie najczęściej używaną opcją. Ponieważ nie tylko dla ObjC (Doxygen obsługuje wiele innych języków), rozwój jest żywy, a społeczność dość silna. HeaderDoc (obecnie projekt open source), dla porównania wydaje się być w dużej mierze w stagnacji. HeaderDoc generuje tylko dane wyjściowe HTML, a Doxygen generuje również PDF, LaTeX i wiele innych formularzy wyjściowych poza HTML. Nawet Apple wydaje się polecać Doxygen, dzięki this przewodnikowi do automatycznego tworzenia zestawów dokumentacji, zgodnych z przeglądarką pomocy Xcode, w ramach procesu budowania Xcode.
Warto zauważyć, że Doxygen może czytać komentarze w stylu HeaderDoc, więc możesz napisać swoją dokumentację w stylu HeaderDoc i zdecydować później, czy tworzyć ostateczne wyniki za pomocą Doxygen lub HeaderDoc.
Doxygen jest bardzo szeroko stosowany. Wydaje mi się, że używam go jako odpowiedzi SO również raz w tygodniu.
Oprócz doxygen jabłko ma narzędzie dostarczane wraz z narzędziami programistycznymi. Generuje typ dokumentacji, którą widzisz na przykład w strukturze SystenConfiguration. Narzędzie nosi nazwę HeaderDoc, a dokumentacja znajduje się pod numerem HeaderDoc User Guide.
Rozwój HeaderDoc jest dość stagnacyjny. Doxygen to o wiele lepszy wybór. Z odpowiednimi dodatkami, Doxygen może być bardzo podobny do nagłówka HeaderDoc, jeśli takie są twoje preferencje. –
Stagnacja czy nie, jest to poprawna opcja do generowania dokumentacji dla Objective-C/C/C++. Osobiście nienawidzę dokumentacji, którą generuje Doxygen. –
Tak właśnie tego szukałem! Jeśli kodujesz przy pomocy Xcode na Macu, dlaczego nie wykorzystasz rzeczy, których Apple używa? – Nils
Sprawdź appledoc. Opiera się na Doxygen. Możesz zobaczyć, że zjada własne karmy dla psów, ponieważ generuje appledoc reference documentation dla. Porównaj na przykład GBComment.h z GBComment Class Reference.
Również przyjrzeć Xcode's Documentation Set Guide kompleksowych instrukcje dotyczące sposobu tworzenia dokumentacji, która współpracuje z Xcode. Są to instrukcje, które appledoc automatyzuje.
Niedawno przeszliśmy z Doxygen do Appledoc i jestem bardzo szczęśliwy, Najlepszą rzeczą w tym przypadku jest to, że szybkie wyskakujące okienko pomocy (boks z opcją) zawiera wszystkie te same informacje, które uzyskasz w dokumentach Apple. Dokumenty wygenerowane przez Doxygen nie mają odpowiedniej struktury, którą mogliby wybrać. – DougW
Komentowanie, że dwie połączone przewodniki zostały przeniesione do [tutaj, aby pisać komentarze] (http://gentlebytes.com/appledoc-docs-comments/) i [tutaj, gdzie znajdują się przykładowe ustawienia wiersza poleceń] (http: // gentlebytes.com/appledoc-docs-settings/). –
Uwaga: Appledoc 2 nie jest już oparty na Doxygen –
Może powinieneś spróbować jazzy przez Realm. To projekt typu open source. jazzy obsługuje zarówno Objective-C & Swift.
"Dane wyjściowe odpowiadają wyglądowi oficjalnej dokumentacji referencyjnej Apple, opublikowanej po WWDC 2014." Które można ocenić na podstawie dostarczonego sample doc.
[UPDATE] (http://stackoverflow.com/questions/813529/documentation-generator-for-objective-c/6487090#6487090): appledoc to nowe i ulepszone rozwiązanie. "[To] używa doxygen jako podstawy do wyodrębniania dokumentacji z plików źródłowych, a następnie konwertuje wyjście doxygen na ładniej wyglądający układ." – ma11hew28
appledoc jest problematyczne - wymaga przypisania go do dokumentacji lub strony internetowej, z której korzystał appledoc. Od kiedy to formatowanie wymaga atrybucji?!? –