Czytam na artykule, jak wygenerować podobną do Apple dokumentację HTML na here. Moje pytania są tym, do czego służą linie poleceń. Jak połączyć linie poleceń i projekt xcode appledoc, aby wygenerować kod HTML.jak używać appledoc do generowania dokumentacji podobnej do Apple
Nie użyłem "appledoc", ale z szybkiego spojrzenia na połączoną stronę wydaje się, że jest to narzędzie wiersza polecenia typu open-source. Pierwszym krokiem będzie więc skompilowanie samego programu "appledoc", a następnie umieszczenie go w katalogu znajdującym się na Twojej ścieżce, takim jak /usr/local/bin lub ~/bin/.
Następnym krokiem jest próba użycia go do wygenerowania dokumentacji (zakładając, że już utworzyłeś pliki przeceny, które zużywa). Otwórz okno terminala, przejdź do katalogu, w którym pliki są, a następnie użyć polecenia podane w górnej części strony, którą powiązany:
appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help .
Jeśli chcesz użyć „appledoc” regenerować dokumentacja każdego w czasie, gdy tworzysz jakiś projekt, możesz dodać fazę "Uruchom skrypt" do istniejącego celu w swoim projekcie lub utworzyć nowy cel tylko dla dokumentacji, która ma tylko fazę "Uruchom skrypt". Tak czy inaczej, skrypt w tej fazie powinien być skryptem powłoki zawierającym polecenie podobne do powyższego (chociaż prawdopodobnie będziesz chciał wyraźnie określić katalog źródłowy, a nie tylko używać "bieżącego" katalogu, tj. .).
Jestem autorem narzędzia appledoc. Narzędzie jest przeznaczone do użycia w odpowiedzi na powyższe pytanie Caleba. Zalecaną metodą instalacji jest klonowanie repozytorium z GitHub, otwarty projekt w Xcode, kompilacja i opcjonalnie kopiowanie plików binarnych do twojej ścieżki, jak zasugerowano powyżej. Dodatkowo należy również skopiować pliki szablonów wymagane do uruchomienia narzędzia do jednej z predefiniowanych ścieżek. Wszystkie wymagane czynności opisano w pliku readme na stronie appledoc pod numerem GitHub, patrz sekcja Szybka instalacja.
Istnieją także inne metody instalacji - cały wkład użytkowników:
install-appledoc.sh skrypt zawartych w repozytorium git.Aby uzyskać dodatkowe pytania, przejdź na stronę appledoc Google group. Właśnie go stworzyłem kilka dni temu, więc w chwili pisania tego tekstu nie ma żadnych treści, ale możesz tam zadawać pytania.
Jak znalazłem na tym post, można wygenerować kompletną dokumentację HTML kod z tej linii komend:
appledoc --project-nazwy BabelCPP --project-firmy "My Name" - -company-id com.mycompany --no-create-docset --output ./doc/.
Ostatni "." jest ścieżką do twojego kodu.
Wątpię, aby większość osób znała projekt "appledoc", więc możesz chcieć nieco wyjaśnić swoje pytanie. – Caleb