2011-07-18 17 views
7

Często znajduję się na Terminalu zamiast w przeglądarce (dla JDK, który pobrałem) iw IDE (Eclipse/NetBeans, dokument zwykle przerzuca się automatycznie po wpisaniu kodu Java), stąd uzyskując dostęp Dokumentacja z Terminalu to (jeden jedyny) najwygodniejszy sposób dla mnie. Szukałem wielu archiwów wątków SO związanych z uzyskiwaniem dostępu do dokumentacji Java z terminala, ale to, co znalazłem, dotyczyło zawsze środowiska przeglądarki lub środowiska IDE.Dokumentacja Java na Terminalu

Czy można uzyskać dokumentację Java z terminala?

Przykł. Jak mogę uzyskać dokumentację Math.max() na terminalu? Wsparcie?

w Perlu zwykle zrobić perldoc -f thefunc

W ruby ​​zwykle zrobić ri -T thefunc na terminalu. Zazwyczaj prowadzi to mnie do wszystkich powiązanych klas/wyliczeń metody, która mnie interesuje nadal w tym samym miejscu = Terminal bez konieczności przeglądania/wyszukiwania w innych oddzielnych lokalizacjach (czy to przeglądarka, wyszukiwany chm doc lub pdf lub jakikolwiek inny miejsca z wyjątkiem tej samej sesji terminalowej). Jeśli stwierdzę, że istnieje więcej niż jedna metoda należąca do klasy/enum (od ri -T max), wówczas ponownie wpisuję pełną ri -T Enumerable#max, aby uzyskać dokładną dokumentację, której potrzebuję. Muszę dwukrotnie wejść do RTFM, ale wciąż jestem w terminalu.

używam

java version "1.5.0_28" 
Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_28-b04-382-9M3326) 
Java HotSpot(TM) Client VM (build 1.5.0_28-157, mixed mode, sharing) 

Mac OS X 10.5.8 

ale pobrałem najnowsze JDK (Java Platform SE 6) ze strony Oracle kilka tygodni temu.

Dzięki za oświecenie!

Odpowiedz

2

W systemie Mac OS X, lynx to jedna alternatywa:

lynx /Users/Shared/javadoc/jdk6/api/java/lang/Math.html 

Uzupełnienie: wygodniej, jeśli poprawne API jest dostępne lokalnie, wystarczy użyć open:

open -a Safari /Users/Shared/javadoc/jdk6/api/java/lang/Math.html 

Uzupełnienie: W BBEdit/TextWrangler, można podać specyficzny język Szablon adresu URL używany w menu kontekstowym: Znajdź w pliku referencyjnym oraz:

http://www.google.com/search?hl=en&q=java+6+__SYMBOLNAME__ 
+1

oczywiście będzie to również działać dla systemu Linux i Cygwin. –

+0

Wierzę, że Lynx jest również przeglądarką. Używanie go do uzyskania 'Math.max()' jest sprytną alternatywą.Ale nie sądzę, abym mógł polegać na tej przeglądarce, aby przeszukać RTFM, a jeśli nie jestem zaznajomiony z metodą, którą szukam, będę musiał najpierw google znaleźć odpowiednią klasę i upewnić się, że nazwa pliku I call to poprawna nazwa klasy. Potrzebuję narzędzia doc, które może wyszukiwać i sugerować jego metodę (lub dowolną inną funkcję, niezależnie od tego, jaka jest jej nazwa w języku Java) oraz klasę, np. 'Ri max' w ruby. Jakieś lepsze alternatywy? Niemniej, dziękuję za odpowiedź, doceniam to. – Arie

+1

Niekoniecznie. Javadoc zazwyczaj ma stronę indeksu, która wymienia wszystkie metody z odnośnikiem do klasy, do której należą. Użyj Lynka, aby uzyskać dostęp do tego indeksu, a następnie użyj wyszukiwania w przeglądarce ("/"), aby znaleźć interesującą Cię metodę. –

0

ja nie wiem, czy może to własnych potrzeb, ale z Twojego pytania myślę, że trzeba szukać możliwości i indeksowanie dla dokumentacji:

Można użyć wersji chm z javadoc , które można pobrać z here. W systemie OSX można przeglądać plik za pomocą przeglądarki opensource chm, takiej jak Chmox.

+0

Ty Mam rację, potrzebuję możliwości przeszukiwania i indeksowania dokumentu, ale to, co do tej pory znajdowałem w społecznościach Javy, zawsze było _browsing_. ** Naprawdę potrzebuję bardziej zaawansowanego jednego rozwiązania rozwiązania z terminala **, takiego jak 'ri-T max' w ruby, może automatycznie zasugerować dowolne powiązane klasy lub wyliczenia metody, która mnie interesuje bez szukania innych odseparowane rozwiązania i wciąż jestem w Terminalu bez przenoszenia do innych lokalizacji (przeglądarki). – Arie

+0

Miałem taki sam problem jak ty (w Windowsie), ale korzystając z skompilowanej dokumentacji, mogę wyszukać metodę lub termin i znaleźć ich klasy, które są z nią powiązane. –

0

Jak zapewne wiesz, narzędzie javadoc renderuje dokumentację do wymaganego formatu za pomocą wtyczki "doclet". This page zawiera dużą liczbę istniejących dokumentów, w tym jedną, która generuje zwykły tekst. Możesz użyć jednego z tych dokumentów do wygenerowania javadocs w żądanym formacie.

+0

Dziękuję za odpowiedź. Nie, nie znałem docletu, zanim dasz mi znać :-) Wrócę do tego wątku, gdy będę mógł się przyzwyczaić do tego dokumentu. – Arie