Chcę, gdybym przejechał myszą nad metodą, byłbym w stanie zobaczyć moją dokumentację tego, co robi metoda, kiedy umieszczę mysz nad metodą Javy Wiem, że/** */jest jak to się robi, ale:Jak udokumentować moją metodę w Javie, tak jak dokumenty Java?
Jak wytłumaczyć, dla czego służy Params?
Jak utworzyć nową linię lub wpisać pogrubienie lub kursywę?
Jeśli używasz Eclipse jako IDE, wystarczy stworzyć komentarz z
/**
i naciśnij enter, aby wygenerować kod dla Javadoc, w tym parametry, wartości zwracane itp. Trzeba tylko wstawić opisy.
To samo odnosi się do deklaracji klasy (komentarz Javadoc zawsze odnosi się do następnego elementu)
Uwaga:
Aby dołączyć dokument do metody należy określić nazwę metody w komentarzach na szczycie .
Na przykład
/**
* create_instance
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance
* respectively.
* @return Instance object
*/
miły! !!!!!!!!!!!! –
W Deed bardzo często używana funkcja –
Możesz zrobić to samo dla intelliJ – Simon
Jak wytłumaczyć to, co stoi za Params?
Zastosowanie @param tag:
/**
* @param paramName Explanation of the param
*/
public void foo(String paramName);
Jak stworzyć nową linię, albo uczynić słowo pogrubienie lub kursywa?
stosować standardowe HTML, tj <p></p>, <br/>, <strong> i <em> (lub mniej semantyczne <b> i <i>)
Proszę przeczytać [DOCS] (http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html) – pb2q