Pobieranie prezentacji. Proszę czekać

Pobieranie prezentacji. Proszę czekać

1 REFERAT: ANT&JAVADOC. ANT & javadoc - Piotr Pracuch2 Część pierwsza: ANT CZĘŚĆ 1: ANT.

Podobne prezentacje


Prezentacja na temat: "1 REFERAT: ANT&JAVADOC. ANT & javadoc - Piotr Pracuch2 Część pierwsza: ANT CZĘŚĆ 1: ANT."— Zapis prezentacji:

1 1 REFERAT: ANT&JAVADOC

2 ANT & javadoc - Piotr Pracuch2 Część pierwsza: ANT CZĘŚĆ 1: ANT

3 ANT & javadoc - Piotr Pracuch3 Część pierwsza: ANT Przy tworzeniu dużych projektów śledzenie które spośród plików wymagają powtórnej kompilacji jest męczące i czasochłonne. Jest to jeden z czynników powstania make'a, programu budującego, czyli aplikacji automatyzującej wszystkie możliwe czynności wchodzące w skład procesu konstrukcji. Pojawił się on wraz z językiem C i był ściśle powiązany z powstaniem systemu Unix. Zalety make'a: - bardzo elastyczny - posiada ogromne możliwości Wady make'a: - można sprawić, żeby działał na różnych platformach, ale sam w sobie nie jest przenośny (co wymaga znacznego wysiłku aby proces konstrukcji przebiegał prawidłowo na różnych platformach), - trudny, zawiły, dokładne poznanie wymaga używania latami (jak wiele narzędzi o korzeniach Unixowych), - typowe dla systemów Unixo-podobnych "przyjazne" dla użytkownika wiadomości o błędach, - „problem tabulatora”, TAB musi być używany do oddzielania komend, Make – prekursor Ant’a

4 ANT & javadoc - Piotr Pracuch4 Część pierwsza: ANT Ant jest częścią projektu Apache Jakarta i opiera się na podobnym założeniu co make jeżeli chodzi o zależności (ang. dependants) i zadania (ang. targets), ale nie zakłada że są to pliki i że głównym celem zależności jest uaktualnienie zadań. Ant używa języka XML, nie jest więc uzależniony od konkretnej platformy, nie używa komend shella. Program ten został napisany z myślą o Javie, więc posiada wiele udogodnień dla programistów tego języka. Ponieważ został napisany w javie, posiada możliwość uruchamiania kompilatora niejako "od wewnątrz", co przyspiesza kompilację. Zalety Ant'a - w pełni niezależny od platformy, - stworzony z myślą o programistach javy, - wygodniejszy w użyciu, - jest szybszy od make'a - dobra obsługa błędów składniowych buildfile'a - posiada wsparcie dla nowych technologii: UnitTesting, JavaDeps (java dependency engine), JavaDoc, gzip, bzip2 Ant

5 ANT & javadoc - Piotr Pracuch5 Część pierwsza: ANT Aby Ant poprawnie działał należy ustawić odpowiednie path-y, dzięki czemu system wie gdzie szukać programu. W Windowsie można to zrobić za pomocą Panelu Sterowania, dla wygody lepiej stworzyć plik wsadowy (setenv.bat), lub w przypadku systemu Unix/Linux, skrypt shella (setenv.sh), które automatycznie ustawią pożądane zmienne systemowe. Zakładając, że Ant znajduje się w katalogu c:\tools\ant (Windows) lub ~/tools/ant (Linux) pliki te wyglądają następująco: : : Setup build environment variables using DOS Batch : set USR_ROOT=c: set JAVA_HOME=%USR_ROOT%\jdk1.4set CLASSPATH=%USR_ROOT%\jdk1.4\lib\tools.jar;%CLASSPATH% set ANT_HOME=%USR_ROOT%\tools\Ant PATH=%PATH%;%ANT_HOME%\bin # # Setup build environment variables using Bourne shell # export USR_ROOT=~ export JAVA_HOME=${USR_ROOT}/jdk1.4 export ANT_HOME=${USR_ROOT}/tools/ant export PATH=${PATH}:${ANT_HOME}/bin Konfiguracja Anta

6 ANT & javadoc - Piotr Pracuch6 Część pierwsza: ANT W programie Ant odpowiednikiem makefile’ów są buildfile’y, główny plik dla projektu nazywa się domyślnie build.xml. Poniżej znajduje się bardzo prosty plik build.xml. W tej chwili nie ważne jest co on robi, przyjrzymy się składni. Jak można zauważyć składnia XMLa jest podobna do HTMLa (również zapis komentarzy identyczny), z tą różnicą, że w XMLu można określać własne nazwy znaczników i należy bezwzględnie przestrzegać składni. Każdy znacznik otwierający musi posiadać znacznik zamykający. Przykład na kolejnym slajdzie. Prosty buildfile

7 ANT & javadoc - Piotr Pracuch7 Część pierwsza: ANT Arybuty wewnątrz znaczników są podawane w cudzysłowiu. Należy zwrócić uwagę na zakończenie znacznika jednowersowego: "/>". Prosty buildfile c.d.

8 ANT & javadoc - Piotr Pracuch8 Uruchamiamy nasz skrypt, żeby zobaczyć jak wygląda rezultat jego działania. Na moim komputerze, po uruchomieniu dla pliku build.xml w katalogu D:\Sudia\II ROK – JTP2\projekt\ Ant wyrzucił na konsoli: Część pierwsza: ANT Wyniki działania Buildfile: D:\Stuff\Studies\II ROK - JTP2\projekt\warcaby\build.xml init: [mkdir] Created dir: D:\Studia\II ROK - JTP2\projekt\warcaby\build BUILD SUCCESSFUL Total time: 188 milliseconds Wykonany został domyślny cel (init), gdyby wpisać ant compile przed BUILD SUCCESSFUL znajdowałaby się jeszcze dwie linie: compile: [javac] Compiling 2 source files to D:\Studia\II ROK - JTP2\projekt\warcaby\build Edytor Eclipse posiada możliwość wywoływania Anta, więc nie musimy budować projektu z konsoli. Robimy to za pomocą polecenia Run/External Tools/Run As/Ant Build. Więcej na ten temat można znaleźć w helpie Eclipse’a.

9 ANT & javadoc - Piotr Pracuch9 Część pierwsza: ANT Zajmiemy się teraz nieco bardziej skomplikowanym przykładem, który można już z powodzeniem wykorzystać przy prostych projektach. Uniwersalny build.xml

10 ANT & javadoc - Piotr Pracuch10 Część pierwsza: ANT Uniwersalny build.xml c.d.

11 ANT & javadoc - Piotr Pracuch11 Część pierwsza: ANT Uniwersalny build.xml c.d.

12 ANT & javadoc - Piotr Pracuch12 Część pierwsza: ANT Projekty (ang. projects) Każdy plik budowy może obsługiwać jeden projekt (w każdym pliku może być jeden tag ). Wewnątrz tagu określono opcjonalne atrybuty name (nazwa projektu), basedir (główny katalog projektu) oraz obowiązkowy atrybut default, określający domyślny cel (opisany przy użyciu znacznika ) wykonywany w wypadku, gdy ant zostanie wywołany bez jawnego określenia celu. Cele (ang. targets) Specyfikacja celu zawiera zależności (ang. dependences) oraz zadania (ang. tasks). Zależności określają, które cele muszą zostać wykonane zanim może być wykonany dany cel. Przykład: Cel „dist” może zostać wykonany tylko, jeżeli wcześniej został wykonany cel „compile”. Składnia: projekty i cele

13 ANT & javadoc - Piotr Pracuch13 Część pierwsza: ANT Zadania (ang. projects) Zadania to fragmenty kodu odpowiedzialne za wykonanie celów, czyli np. kompilacja, czy usuwanie plików. Przykład z naszego build.xml: W powyższym przykładzie zadaniem jest wywołanie kompilatora javy. Własności (ang. property tags) Własności pozwalają na definiowanie stałych łańcuchów znaków, które mogą być powtórnie użyte. Deklaracja: Wywołanie: Składnia: zadania i własności

14 ANT & javadoc - Piotr Pracuch14 Część pierwsza: ANT Jak można zauważyć wywołanie odbywa się w następujący sposób: ${nazwa- własności}. Jeżeli pracujemy nad dużym projektem, ilość własności w build.xml może być bardzo duża, co oczywiście przeszkadza. W takim wypadku możemy wyrzucić je do osobnego pliku, a następnie zaimportować: Składnia: własności c.d.

15 ANT & javadoc - Piotr Pracuch15 Część pierwsza: ANT Cele mogą być wykonane lub też nie w zależności od tego, czy ustawiono dana własność, czy też nie. Jeżeli chcemy, żeby cel został wykonany tylko, jeżeli własność production została określona, cel definiujemy następująco: Aby zdefiniować cel, który jest wykonywany tylko jeżeli własność production nie została określona: Cele warunkowe (ang. conditional targets)

16 ANT & javadoc - Piotr Pracuch16 Część pierwsza: ANT Przy tworzeniu dużych projektów często wykorzystywana jest dostępna w Ancie możliwość wywoływania jednego builda przez inny. Pozwala to na budowanie hierarchicznej struktury skryptów. Przykłady: Wywołanie innego builda z bieżącego wraz z przekazaniem własności: Wywołanie inngeo builda z bieżącego (ponieważ nie sprecyzowano nazwy pliku, przyjęta będzie domyślna: build.xml): Wywołanie inngeo builda z bieżącego wraz ze sprecyzowaniem celu: Używanie wielu build-ów

17 ANT & javadoc - Piotr Pracuch17 Część pierwsza: ANT Wszystko co trzeba wiedzieć na temat Anta i jeszcze więcej można znaleźć w dokumentacji pod adresem Przypomina ona nieco w swojej formie dokumentacje generowane przez javadoc’a i jest bardzo wygodna w użyciu.http://ant.apache.org/manual/index.html Dokumentacja do Anta

18 ANT & javadoc - Piotr Pracuch18 Część druga: JAVADOC CZĘŚĆ 2: JAVADOC

19 ANT & javadoc - Piotr Pracuch19 Część druga: JAVADOC Projektanci Javy zadbali nie tylko o wygodne tworzenie programów, ale również dokumentacji do nich. Jeżeli dokumentacja do programu byłaby przechowywana w oddzielnym pliku, zmiana opisu może być sporym problemem, gdy zmieniamy kod. Rozwiązaniem jest umieszczenie dokumentacji razem z kodem i wykorzystanie jakiegoś narzędzia, które umożliwiłoby przetworzenie jej na formę bardziej użyteczną. Takim narzędziem jest właśnie javadoc. Wykorzystuje on specjalne znaczniki umieszczane w komentarzach do wygenerowania dokumentacji w formacie HTML. Zastosowanie javadoc’a niesie ze sobą wiele korzyści, przede wszystkim upraszcza i przyspiesza tworzenie oraz modyfikowanie dokumentacji i wprowadza pewnego rodzaju standard dla dokumentacji bibliotek. Dzięki temu, po oswojeniu się ze strukturą dokumentacji nie będziemy mieli problemów ze zrozumieniem i odnalezieniem informacji w dokumentacji żadnej innej biblioteki. Aby wygenerować dokumentację javadoc’a: javadoc -d doc/ pracuch.jtp.example spowoduje stworzenie w katalogu doc dokumentacji pakietu pracuch.jtp.example javadoc

20 ANT & javadoc - Piotr Pracuch20 Część druga: JAVADOC Większa część dokumentacji generowana jest na podstawie czystego kodu źródłowego. Opisywane są wszystkie metody i pola występujące w dokumentowanych plikach. Dokumentacja generowana przez JavaDoc odpowiada stanowi faktycznemu (temu co znajduje się w pliku *.class. Poniżej znajduje się lista plików jakie zostaną wygenerowane przez javadoc’a. Pliki podstawowe nazwa.html dla każdej klasy lub interfejsu podlegającego dokumentacji package-summary.html - dla każdego dokumentowanego pakietu. Plik ten zawiera podsumowanie pakietu overview-summary.html - podsumowanie całej dokumentacji Strony z zależnościami overview-tree.html - plik z hierarchią klas package-tree.html - hierarchia klas konkretnego pakietu package-use.html i classuse/classname.html - lista klas/pakietów, używanych przez dany pakiet lub klas e index-*.html - Indeks klas - może być zorganizowany w jeden plik, albo w serię plików index-litera.html - oddzielnie dla każdej litery Pliki pomocnicze (np.. index.html, style.css) Zawartość dokumentacji

21 ANT & javadoc - Piotr Pracuch21 Część druga: JAVADOC Komentarze javadoc’a występują wyłącznie wewnątrz komentarzy typu „/** */”. W sposobie dokumentowania możemy wyróżnić dokumentowanie przez osadzony kod HTML oraz znaczniki dokumentacyjne, które umieszcza się przed omawianym elementem. Kod HTML po przejściu przez javadoc’a jest automatycznie włączany do dokumentacji. Daje to duże możliwości edycyjne. Poniżej prosty przykład: /** * * System.out.println(new Date()); * */ Należy zwrócić uwagę na gwiazdki przed każdą z linii. Są one pomijane przez javadoc’a, można je stosować lub nie. Należy zaznaczyć, że nie powinno się nadużywać znaczników HTML, ponieważ na przykład znacznik headera spowoduje zakłócenie hierarchii nagłówków automatycznie ustawianych przez javadoca. składnia

22 ANT & javadoc - Piotr Pracuch22 Część druga: JAVADOC Zanim zajmiemy się dokładniejszym omówieniem składni, przykład komentarza /** * Returns an Image object that can then be painted on the screen. * The url argument must specify an absolute URL}. The name * argument is a specifier that is relative to the url argument. * * This method always returns immediately, whether or not the * image exists. When this applet attempts to draw the image on * the screen, the data will be loaded. The graphics primitives * that draw the image will incrementally paint on the screen. * url an absolute URL giving the base location of the image * name the location of the image, relative to the url argument the image at the specified URL Image */ public Image getImage(URL url, String name) { try { return getImage(new URL(url, name)); } catch (MalformedURLException e) { return null; } Przykład użycia

23 ANT & javadoc - Piotr Pracuch23 Część druga: JAVADOC Wygenerowany kod wygląda następująco: getImage public Image getImage(URL url, String name)ImageURLString Returns an Image object that can then be painted on the screen. The url argument must specify an absolute URL. The name argument is a specifier that is relative to the url argument. This method always returns immediately, whether or not the image exists. When this applet attempts to draw the image on the screen, the data will be loaded. The graphics primitives that draw the image will incrementally paint on the screen. URL Parameters: url - an absolute URL giving the base location of the image name - the location of the image, relative to the url argument Returns: the image at the specified URL See Also: Image Przykład użycia c.d.

24 ANT & javadoc - Piotr Pracuch24 Część druga: JAVADOC Po przyglądnięciu się kodowi oraz wynikowi działania javadoc’a stwierdzamy, że jak powiedziano wcześniej kod HTML jest automatycznie włączany do wygenerowanej dokumentacji (w przykładzie użyto znacznika - paragraf). Należy podkreślić znaczenie pierwszego wersu komentarza javadoc’a, ponieważ jest on kopiowany do podsumowania pakietu. Ponadto zauważamy obecność wyrażeń Są to tzw. znaczniki dokumentacyjne, jest ich kilkanaście i stanowią podstawę standaryzacji dokumentacji generowanych przez javadoc’a. Jeżeli nie znajdują się na początku linii należy umieszczać je w nawiasach klamrowych. Przyjrzyjmy się fragmentowi url an absolute URL giving the base location of the image * name the location of the image, relative to the url oraz odpowiadającemu mu fragmentowi dokumentacji Parameters: url - an absolute URL giving the base location of the image name - the location of the image, relative to the url argument Znacznik ten jest używany do dokumentacji metod, a konkretnie do opisu ich argumentów. Przykład użycia c.d.

25 ANT & javadoc - Piotr Pracuch25 Część druga: informacje-o-autorze Wywołanie javadoc z opcią –author spowoduje umieszczenie informacji o autorze w dokumentacji (standardowo jest to opcja informacje-o-wersji Zgodnie z konwencją używamy następującej informacji „%I%, %G%”, co zamienia się w coś w stylu „1.15, 11/21/03” (miesiąc, dzień, rok) nazwa-parametru opis Służy do opisu metod. Nazwa parametru musi się zgadzać z nazwą podaną na liście parametrów metody. Opis kończy się wraz z następnym opis Opisuje znaczenie zwracanej przez metodę Opisuje właściwości, które zostały wyparte przez nowsze wersje i są niezalecane. Używanie metod oznaczonych tym znacznikiem spowoduje wyświetlenie ostrzeżenia kompilatora. Ważniejsze znaczniki dokumentacyjne

26 ANT & javadoc - Piotr Pracuch26 Część druga: Znacznik pozwala wskazać wersję kodu, od której rozpoczęto stosowanie danej pełne-określenie-nazwy-klasy opis Pełne określenie oznacza jednoznacznie określa nazwanie klasy wyjątku, który może się pojawić wraz z opisem przyczyny. Przykład /** IOException If an input or output exception occurred */ public void f() throws IOException { // body nazwa-klasy#nazwa-metody i inne W oparciu o ten znacznik buduje się sieć dokumentacji. Wstawia on linka do części dokumentacji dotyczącej innej pakiet.klasa#metoda etykieta Podobne działanie ale może być stosowany w środku wiersza, zamiast „See also” wyświetlana etykieta. Ważniejsze znaczniki dokumentacyjne c.d.

27 ANT & javadoc - Piotr Pracuch27 Część druga: JAVADOC ZnacznikDo czego informacje-o-autorzeinformacja o informacje-o-wersjiinformacja o nazwa-parametru opisopisuje opisopisuje zwracaną niezalecane której wersji pełne-określenie-nazwy-klasy opismożliwe nazwa-klasy#nazwa-metody pakiet. nazwa-klasy #nazwa-metody etykietaodnośnik z etykietą

28 ANT & javadoc - Piotr Pracuch28 Część druga: JAVADOC Doclety są to narzędzia języka Java stworzone z myślą o generacji dokumentacji. Ze względu na swoje możliwości są także wykorzystywane do innych celów, przede wszystkim wyszukiwania błędów. Standardowy doclet dołączony do javadoc’a generuje dokumentację w formacie HTML. Przydatne opcje: -d katalog - docelowy katalog w którym zostanie stworzona dokumentacja. -version - dołącza do dokumentu -author - dołącza do dokumentu -nocomment - generuje dokumentację bez dodanych przez użytkownika komentarzy -splitindex - dzieli plik indeksu na wiele liter, każdy plik zawiera jedną literę -windowtitle title - określa tytuł strony podany w znaczniku. -doctitle -określa tytuł jaki będzie miała część overview dokumentu. -header naglowek - określa nagłówek jaki będzie umieszczony w każdym pliku wyjściowym. Dostępne są także inne doclety umożliwiające generowanie dokumentacji w różnych formatach. Warte uwagi są następujące doclety: UMLDoclet (tworzenie dokumentów HTML z diagramami klas wg standardu UML), PDFDoclet (tworzenie dokumentów w formacie PDF), LATEXDoclet (tworzenie dokumentów w formacie LATEX), ImageDoclet (tworzenie dokumentów w formacie JPEG). Doclety

29 ANT & javadoc - Piotr Pracuch29 Część druga: JAVADOC Przed rozpoczęciem pracy z javadoc’em należy zapoznać się z konwencjami jakie panują przy pisaniu komentarzy (używanie gwiazdek, kolejność znaczników, używanie tabulacji, spacji, znaczników HTML i inne). Przy tworzeniu dokumentacji aplikacji/bibliotek pomocne okazują się środowiska IDE (również Eclipse), które ułatwiają wprowadzanie i automatycznie generują niektóre znaczniki dokumentacyjne. Zalety javadoc’a: szybkie tworzenie i dokonywanie zmian w dokumentacji ujednolicenie dokumentacji prosta obsługa darmowy javadoc - podsumowanie

30 ANT & javadoc - Piotr Pracuch30 Część trzecia: JAVA2HTML CZĘŚĆ 3: JAVA2HTML

31 ANT & javadoc - Piotr Pracuch31 Część trzecia: JAVA2HTML Java2Html to bardzo przydatne narzędzie, które pozwala na konwersję kodu Java do formatów HTML, RTF, TeX oraz XHTML w pewien sposób koloryzując kod (ang. syntax highlighting). Na stronie domowej dostępna jest wersja online w formie apletu, aplikacja standalone (http://www.java2html.de/java2html_32.zip) oraz wtyczka do edytora Eclipse (http://www.java2html.de/java2html_eclipse_132.zip). W przypadku wtyczki, archiwum wystarczy rozpakować do katalogu z pluginami Eclipse'a i zresetować edytor.http://www.java2html.de/java2html_32.ziphttp://www.java2html.de/java2html_eclipse_132.zip Style Java2Html pozwala na używanie różnych styli zdefiniowanych przez twórców programu. Na kolejnym slajdzie pokazano kod po konwersji dla różnych styli. Java2Html

32 ANT & javadoc - Piotr Pracuch32 Część trzecia: JAVA2HTML Wybrany stylSformatowany tekst na wyjściu Styl „Kawa” /** * This is about ClassName. * com.yourCompany.aPackage.SuperClass} author */ public class ClassName extends SuperClass { /* This comment may span multiple lines. */ private int integer = 0; public final static char character = 'A'; // This comment may span only this line private String string = "zero"; } Styl „Eclipse” /** * This is about ClassName. * com.yourCompany.aPackage.SuperClass} author */ public class ClassName extends SuperClass { /* This comment may span multiple lines. */ private int integer = 0; public final static char character = 'A'; // This comment may span only this line private String string = "zero"; } Styl „Monochrome” /** * This is about ClassName. * com.yourCompany.aPackage.SuperClass} author */ public class ClassName extends SuperClass { /* This comment may span multiple lines. */ private int integer = 0; public final static char character = 'A'; // This comment may span only this line private String string = "zero"; }

33 ANT & javadoc - Piotr Pracuch33 Część trzecia: JAVA2HTML Używając JAVA2Html oraz Anta można w automatycznie konwertować pliki źródłowe javy. W poniższej tabeli umieściłem najważniejsze parametry jakie można umieścić w tagu java2html w pliku budującym Anta. Opcje konwersji. Java2Html & Ant AtrybutOpisCzy jest konieczny? srcdirKatalog ze źródłami (oraz podkatalogi ze źródłami) do konwersji tak destdirKatalog dla plików wyjściowychtak outputFormatTyp pliku wyjściowego (dostępne wartości: html, tex, rtf, xhtml) nie (domyślnie html) tabsSzerokość znaku tabulacji w spacjachnie (domyślnie 2) styleUstawia styl wyjściowego pliku (dostępne wartości: kawa, eclipse, monochrome) nie (domyślnie kawa) showLineNumbersPokaż numer linii (true/false)nie (domyślnie true) showFileNamePokaż nazwę pliku (true/false)nie (domyślnie false) showFileNamePokaż border tabeli (true/false)nie (domyślnie false)

34 ANT & javadoc - Piotr Pracuch34 Część trzecia: JAVA2HTML Poniżej znajduje się prosty przykład, gdzie wszystkie pliki o rozszerzeniu *.java z ${src.dir} i podkatalogów są konwertowane do katalogu ${scratch.dir} przy użyciu stulu "eclipse". Dodane są numery linii, nazwy plików oraz bordery tablic. Java2Html & Ant c.d.

35 ANT & javadoc - Piotr Pracuch35 Część trzecia: JAVA2HTML Oczywiście nie musimy korzystać z Anta, poniżej znajduje się krótki program który zamienia podany kod javy na format HTML. Przykład używa java.io.StringReader oraz java.io.StringWriter do czytania i wypisywania tekstu, możemy zamiast nich użyć java.io.FileReader i java.io.FileWriter i operować na plikach. // wprowadzamy kod do edycji StringReader stringReader = new StringReader( "/** Prosty przykład użycia Java2Html */\r\n"+ "public static int doThis(String text){return text.length() + 2;}„ ); // przekazujemy tekst do obiektu JavaSource JavaSource source = null; try { source = new JavaSourceParser().parse(stringReader); } catch (IOException e) { e.printStackTrace();System.exit(1); } // tworzymy konwerter i zapisujemy obiekt JavaSource jako HTML JavaSource2HTMLConverter converter = new JavaSource2HTMLConverter(source); StringWriter writer = new StringWriter(); try { converter.convert(writer); } catch (IOException e) {} // wypisanie zawartości System.out.printl (writer.toString()); Użycie biblioteki Java2Html

36 ANT & javadoc - Piotr Pracuch36 Część trzecia: JAVA2HTML Rezultat wykonania tego programu wygląda następująco: 1 /** Prosty przykład użycia Java2Html */ 2 public static int doThis(String text){ return text.length() + 2; } Aby ustawić opcje konwersji używamy parametrów umieszczonych w tabeli pokazanej wcześniej. Zmodyfikujemy nasz program dodając następujący kod: // pobiera domyślne ustawienia Java2HtmlConversionOptions options = Java2HtmlConversionOptions.getDefault(); //... i modyfikuje je options.setShowLineNumbers(false); options.getStyleTable().put( JavaSourceType.KEYWORD, new JavaSourceStyleEntry(Color.orange, true, false)); // ustawia wybrane przez nas opcje dla danego obiekt JavaSource2HTMLConverter converter.setConversionOptions(options); Użycie biblioteki Java2Html c.d.

37 ANT & javadoc - Piotr Pracuch37 Część trzecia: JAVA2HTML Rezultat wykonania tego programu wygląda następująco: /** Simple Java2Html Demo */ public static int doThis(String text){ return text.length() + 2; } Jak widać zmieniły się kolory oraz zniknęły numery linii. Konwersja string  string Możliwa jest konwersja kodu Javy bezpośrednio ze Stringa do Stringa, jednak tracimy wtedy możliwość korzystania z większości możliwości biblioteki Java2Html. Do tego celu wykorzystujemy metodę Convert2Html, o następującej składni: public static java.lang.String convertToHtml(java.lang.String kod, Java2HtmlConversionOptions opcje) Należy zaznaczyć, że aplikacja nie jest dopracowana i robi błędy (np. niepoprawnie skonwertowała przykład 2 slajdy wstecz) Użycie biblioteki Java2Html c.d.

38 ANT & javadoc - Piotr Pracuch38 Część czwarta: ŹRÓDŁA ANT Richard Hightower – „Developing Web Applications with Ant” Ant Manual - Ashley J.S Mills "ANT tutorial” Bruce Eckel – „Thinking in Java” 3rd edition JAVADOC ”How to Write Doc Comments for Javadoc™Tool” Javadoc tutorial Bruce Eckel – „Thinking in Java” 3rd edition JAVA2HTML Java2Html documentation – Źródła


Pobierz ppt "1 REFERAT: ANT&JAVADOC. ANT & javadoc - Piotr Pracuch2 Część pierwsza: ANT CZĘŚĆ 1: ANT."

Podobne prezentacje


Reklamy Google