Wie dokumentiere ich meine Methode in Java wie Java-Dokumente?

Question

Ich mag, dass, wenn ich die Maus über ein Verfahren ich in der Lage sein würde, meine Dokumentation das, was die Methode, um zu sehen tut, wie wenn ich mit der Maus über Java-Methode habe ich weiß, dass/** */ist, wie ihre getan, aber:

1. Wie erklären Sie, wofür die Params steht?

2. Wie erstellen Sie eine neue Zeile oder machen Sie ein Wort fett oder kursiv?

Answer 1

Wenn Sie Eclipse als IDE verwenden, müssen Sie einfach einen Kommentar erstellen mit

/** 

und drücken Sie die Eingabetaste und es wird Ihren Code für Ihren Javadoc generieren, einschließlich Parameter, Rückgabewerte usw. Sie müssen nur die Beschreibungen eingeben.

Gleiches gilt für Klassendeklarationen (die Javadoc-Kommentar bezieht sich immer auf das folgende Element)

Hinweis:

Um doc auf Ihrer Methode legen Sie Methodennamen in den Kommentaren an der Spitze angeben müssen .

Zum Beispiel

/** 
* create_instance 
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
* respectively. 
* @return Instance object 
*/ 

Answer 2

Wie erklären Sie sich, was die Params für Stände?

Verwenden @param tag: ein Wort fett oder kursiv

/** 
* @param paramName Explanation of the param 
*/ 
public void foo(String paramName); 

Wie erstellen Sie eine neue Zeile oder machen?

Verwenden Sie Standard-HTML, dh <p></p>, <br/>, <strong> und <em> (oder weniger semantische <b> und <i>)