Innehållsförteckning:

Var lägger jag Javadoc-kommentarer?
Var lägger jag Javadoc-kommentarer?

Video: Var lägger jag Javadoc-kommentarer?

Video: Var lägger jag Javadoc-kommentarer?
Video: How to use Javadoc Comments in Java program for Documentation ?. 2024, Maj
Anonim

De javadoc verktyget låter dig sätta din kommentarer precis bredvid din kod, inuti din ". java " källfiler. När du är nöjd med din kod och kommentarer , kör du helt enkelt javadoc kommandot och din HTML-stil dokumentation skapas automatiskt åt dig.

Hur lägger du sedan till kommentarer till en Javadoc?

Tänk på följande vid användning Lägg till Javadoc-kommentar (Alt+Skift+J): Till Lägg till a kommentar till ett fält, placera markören på fältdeklarationen. Till Lägg till a kommentar till en metod, placera markören var som helst i metoden eller på dess deklaration.

vad är användningen av Javadoc-kommentarer? Javadoc är ett verktyg som kommer med JDK och det är det Begagnade för att generera Java koddokumentation i HTML-format från Java källkod, som kräver dokumentation i ett fördefinierat format. Följande är ett enkelt exempel där linjerna inuti /*…. */ är Java flera rader kommentarer.

Därav, var lägger jag Javadoc?

Du kan placera JavaDoc-kommentarer på någon av tre olika platser i en källfil:

  1. Omedelbart före deklarationen av en offentlig klass.
  2. Omedelbart före deklarationen av ett allmänt fält.
  3. Omedelbart före deklarationen av en offentlig metod eller konstruktör.

Hur skriver jag Javadoc-kommentarer i Intellij?

3 svar. Om du skriver /** + och sedan trycker på Enter ovan kommer en metodsignatur att skapas Javadoc stubbar för dig. Du kan använda sig av åtgärden 'Fix doc kommentar '. Den har ingen standardgenväg, men du kan tilldela genvägen Alt + Shift + J till den i tangentöversikten, eftersom den här genvägen inte används för något annat.

Rekommenderad: