Wykład - Komentarze javadoc

Nasza ocena:

3
Pobrań: 49
Wyświetleń: 966
Komentarze: 0
Notatek.pl

Pobierz ten dokument za darmo

Podgląd dokumentu
Wykład - Komentarze javadoc - strona 1 Wykład - Komentarze javadoc - strona 2 Wykład - Komentarze javadoc - strona 3

Fragment notatki:

Programowanie w języku Java dr Grzegorz Filipczyk
Wykład 1
Java dokumentowanie programów
Komentarze javadoc
/** komentarz */
Pozwalają dokumentować tworzony program na dwa sposoby:
osadzony kod HTML,
znaczniki javadoc Komentarze javadoc powinny dotyczyć trzech elementów tworzonego programu:
klas,
metod,
zmiennych
/** Komentarz dla klasy */
public class Przykladowa {
/** Komentarz dla metody */
public void metoda() {}
/** Komentarz dla zmiennej */
public int zmienna;
}
Komentarze jako osadzony HTML
Kod HTML użyty w komentarzach jest dodawany bezpośrednio do wygenerowanej dokumentacji
/**
element 1
element 2
element 2

*/
Komentarze używające znaczniki javadoc
@see nazwa_klasy @see nazwa_klasy#nazwa_metody Odwołania do klas zostaną dodane w sekcji See Also dokumentacji
@version informacja_o_wersji @author informacja_o_autorze @since informacja_od_kiedy_obowiazuje @param nazwa_parametru opis_parametru @return opis_zwracanej_wartosci @throws nazwa_wyjatku opis_wyjatku @deprecated nie_zalecane_wlasciwosci Przykład
import java.util.*;
/**
*
* @author Kowalski Jan
* @author kowalski.jan@ae.katowice.pl * @version 1.0
*/
public class Parametry {
/** Główna klasa aplikacji
* @param args tablica parametry przekazane do metody w wierszu poleceń
* @return brak zwracanych wartosci */
public static void main(String[] args)
{
for(int i=0; i

(…)

… innego konstruktora tej samej klasy Destruktor klasy
Java automatyczne usuwa zbędne dane z pamięci operacyjnej dlatego klasa nie musi zawierać destruktora. Jeżeli konieczne jest zwolnienie innych zasobów systemu to można wykorzystać metodę finalize(), które jest automatycznie wywoływana przy usuwaniu danych po zniszczonych obiektach
Metody klasy
Deklaracja metody przybiera postać:
ZwracanyTyp nazwaMetody(/* lista argumentów */)
{
/* ciało metody */
}
Klasy oraz zmienne składowe mogą być deklarowane jako:
public
private protrcted Słowo kluczowe this
Słowo kluczowe this zwraca referencję do obiektu, na rzecz którego metoda została wywołana.
Statyczne metody klasy
Użycie w odniesieniu do metody modyfikatora static powoduje utworzenie metody statycznej, czyli takiej która nie operuje na obiektach. Wywołanie metody statycznej przybiera postać
nazwaKlasy.nazwaMetidyStatycznej() Metody statyczne można używać gdy:
metoda nie potrzebuje dostępu do obiektu (np. Math.pow(x, y))
metoda odwołuje się tylko do zmiennych statycznych klasy
Statyczne zmienne składowe
Użycie modyfikatora static w odniesieniu do zmiennych składowych klasy powoduje zdefiniowanie statycznej zmiennej składowej. Statyczna zmienna…


}
Konstruktor klasy
Konstruktor nosi tę samą nazwę co klasa
Klasa może posiadać więcej niż jeden konstruktor
Konstruktor nie zwraca wartości
Konstruktor jest zawsze wywoływany przez operator new Jeżeli konstruktor nie inicjuje wartości zmiennych składowych klasy to automatycznie zostaną im nadane wartości domyślne
0 (zero) dla wartości liczbowych
false - dla wartości logicznych
null - dla referencji…
... zobacz całą notatkę

Komentarze użytkowników (0)

Zaloguj się, aby dodać komentarz