On poso els comentaris de Javadoc?
On poso els comentaris de Javadoc?
Anonim

El javadoc utilitat us permet posar teu comentaris just al costat del vostre codi, dins del vostre ". java " fitxers font. Quan estigueu satisfet amb el vostre codi i comentaris , simplement executeu el javadoc comanda i el vostre estil HTML documentació es crea automàticament per a tu.

Aleshores, com s'afegeixen comentaris a un Javadoc?

Tingueu en compte el següent quan feu servir Afegeix un comentari de Javadoc (Alt+Maj+J): a afegir a comentar a un camp, col·loqueu el cursor a la declaració de camp. A afegir a comentar a un mètode, col·loqueu el cursor en qualsevol lloc del mètode o de la seva declaració.

de què serveixen els comentaris Javadoc? Javadoc és una eina que ve amb JDK i ho és utilitzat per generar Java documentació del codi en format HTML des de Java codi font, que requereix documentació en un format predefinit. A continuació es mostra un exemple senzill on les línies dins de /*…. */ són Java multilínia comentaris.

D'això, on poso Javadoc?

Podeu col·locar comentaris de JavaDoc en qualsevol de les tres ubicacions diferents d'un fitxer font:

  1. Immediatament abans de la declaració de classe pública.
  2. Immediatament abans de la declaració de terreny públic.
  3. Immediatament abans de la declaració d'un mètode o constructor públic.

Com escric comentaris Javadoc a Intellij?

3 respostes. Escrivint /** + i després prement Retorn a sobre es crearà una signatura de mètode Javadoc talons per a tu. Tu pots utilitzar l'acció 'Fix doc comentar '. No té una drecera predeterminada, però podeu assignar-li la drecera Alt + Maj + J al mapa de tecles, perquè aquesta drecera no s'utilitza per a res més.

Recomanat: