Cosa fa l'annotazione java @code

Question

Ho provato a cercare nella documentazione di Oracle per una spiegazione di cosa fa l'annotazione java @code java.

Da una domanda precedente, mi sono reso conto che ha qualcosa a che fare con l'HTML, ma non sono sicuro di quello che ...

sarebbe corretto dire che da javadoc impostazione predefinita viene analizzato come HTML. .. Ma posizionare l'annotazione @code accanto ad un testo javadoc indicherà che dovrebbe essere trattato come codice e non analizzato/reso nel solito modo? Così, per esempio:

/** 
    *This is how to declare an int variable {@code int var=1;} 
    */ 

Vorrei che sia una vera e propria esempio del suo utilizzo?

Answer 1

{@code } è un tag Javadoc che racconta Javadoc che il testo all'interno delle parentesi graffe è il codice e non deve essere trattato come HTML. Javadoc dovrebbe anche formattare il testo in un blocco di codice in modo diverso rispetto all'altro testo. Questo concetto è molto simile al testo "codice di esempio" utilizzato dall'editor di StackOverflow quando si formatta una domanda o una risposta.

Answer 2

Se si desidera aggiungere JavaDocs per un metodo. Forse non sai che cosa sono Javadocs

Quindi la cosa in giallo è un Javadoc qui Se si desidera aggiungere codice per un metodo come un Javadoc allora si può annotare con @code per gli altri usando il metodo per vedere il metodo come esempio. e perché dobbiamo usarlo perché se non lo facciamo la formattazione non sarà corretta

È possibile fare riferimento alla seguente domanda se si desidera verificare le modifiche nella formattazione che si verificano se non si aggiungere il @code: Multiple line code example in Javadoc comment