comentários / javadoc

Programação Java
#1

Galerinha dentro de um trecho para comentários com javadoc tipo:

/**
*

  • @author XXX
    */
  1. Eu posso usar qq tag html neste trecho ? vcs constuma fazer isso ?
  2. Este @author e em geral o @ tem algum significado para o javadoc ?
#2

Os comentarios especiais JAVADOC são usados para ser extraidos por geradores de documentação automatizados e pode se usar todas tags de comuns do HTML <b><p><i> etc …
as tagas especias @xxx são relacionadas a algumas tags que o propio javadoc entende vou dar exemplo de algumas:

@author: Define o autor da classe
@version: Define a versão da classe
@see: linka a um nome de classe especificada
@param: nome e descrição dos paramentros de um metodo
@return: descrição do valor de retorno
@exception: descrição da exceção lançada
@deprecated: declara items como sendo obsoletos

e uma boa conduta documentar sua classe e seus metodos para que quando for utiliza-los possa saber certo oque faz quais são seus retorn em seus metodos e seus parametros assim como suas excessões, não e obrigatorio mais e uma boa conduta falow.

PARA QUE USAR PAREDES SE POSSO VIVER SEM JANELAS !!!
SEJA LIVRE USE LINUX !!!

#3