2012-08-29 12 views
10

Czy istnieje narzędzie do dokumentowania wielu powiązań Xcode, gniazd i powiązań IBAction, powiązań wartości kluczy itp.? Spojrzałem na wątki na Doxygen i HeaderDoc, ale te pliki programów dokumentu, aby opisać klasy itp., Ale nie wydają się obejmować ogromną liczbę "ukrytych" powiązań, które umożliwia funkcja przeciągania i upuszczania Xcode?Samodzielna dokumentacja Xcode i XIB

Specyficzny przykład: mogę użyć edytora XIB do utworzenia IBAction dla każdej kontrolki w moim oknie, do metod w jednej lub kilku klasach/instancjach, zdefiniowanych w jednym lub większej liczbie plików - chcę JEDNĄ listę wszystkich tych , pokazując typ i nazwę kontrolną, plik źródłowy, klasę i metodę - lub graficzne przedstawienie byłoby jeszcze lepsze. Następnie podobna lista dla ścieżki wartości klucza łączy się z arrayControllers itp.

Jestem nowy, więc jeśli przegapiłem coś oczywistego, proszę powiedz mi.

Dzięki.

Odpowiedz

4

Nie, nie ma narzędzia do dokumentowania plików .xib, chyba że sam plik jest częścią dokumentacji. (W końcu powiedziałeś "self documenting".). Xibs są przechowywane jako XML, więc jeśli naprawdę chcesz wyodrębnić dane, to jest to możliwe.

Czynności tworzone w IB pojawiają się w kodzie źródłowym. Można tam dodawać komentarze opisujące obiekt, który wysyła akcję, ale w dużej mierze pomijałoby to konieczność użycia .xib (i akcji), czyli odseparowania elementów interfejsu od kontrolera.

Jeśli celem dokumentacji jest ułatwienie zrozumienia projektu innym programistom, możesz chcieć zdobyć więcej doświadczenia z Objective-C, zanim będziesz mieć problemy z tworzeniem narzędzia do dokumentowania .xib. Biorąc pod uwagę plik .xib i odpowiednie pliki nagłówkowe, każdy kompetentny programista Obj-C powinien być w stanie łatwo określić, które elementy sterujące są połączone z wybranymi działaniami lub debugować problemy w tym obszarze. Ludzie pracują z plikami .xib i .nib od ponad 20 lat - brak osobnego narzędzia do dokumentacji może być dobrym wskazaniem, że coś takiego może nie być tak przydatne, jak się wydaje na początku.