Re:JavaDoc

10 respostas
erickcellani

intaum cara… enquanto ao javadoc… está errado…

eu vi que vc está usando @param para qualquer coisa… e naum é certo… vc deve usa-lá se vc tiver que passar um parametro mesmo…
exemplo:

/**
	 * @param valor Valor a ser formatado.
	 * @param minDecimal Quantidade minima de casas decimais.
	 * @param maxDecimal Quantidade maxima de casas decimais.
	 * @return Valor formatado
	 */
	public static String formatFloat(float valor, int minDecimal, int maxDecimal) {

e em metodos que naum tem parametro para passar… naum precisa colocar
/**

  • @param
    */

a pior coisa que existe é documentação errada… cuidado com isso!

espero ter ajudado!

10 Respostas

erickcellani

bom naum sei quem te flw isso… mas é uma grande mentira…
o método pode ser void!

enquanto a sua outra duvida… vc se refere a qual varialvel ?

erickcellani

pode deixar… está certo!
ficou até bunito… usa-lá como constante… nos meus codigos eu uso assim tbm!

Obs.: qnd vc kiser usar o javadoc e naum tiver nenhum parametro ou retorno ou qualquer outra coisa vc pode fazer assim:
(vou usar sua variável como exemplo)

/**
 * Armazena a constante driver de conexão
 */
private final String DRIVER = "com.mysql.jdbc.Driver";

pq ai sai na documentação corretamente!
:wink:

L

Everson, você utiliza Eclipse certo? Então procure um plugin chamado ChekStyle ele controla sua aplicação no padrão SunCodeConventions ira te ajudar bastante com os JD’s

Abraço

erickcellani
everson_z:
O javabean fica assim?
/** Classe de atributos
 * @author Everson
 * @since 18/04/2007
 */
public class Usuario {
    
         private String bairro

	/**
	 * @return bairro String
	 */
	public String getBairro() {
		return bairro;
	}
	/**
	 * @param bairro String
	 */
	public void setBairro(String bairro) {
		this.bairro = bairro;
	}
}

isso mesmo!

cassioso

eu faço um pouco diferente…

/**
	 * Classe que representa um usuário do módulo XXX
	 * 
	 * @author Cássio
	 * @since 18/04/2007
	 */
	public class Usuario {

		private String bairro;

		/**
		 * Cria um usuário. Seus atributos devem ser manipulados pela interface
		 * publica disponibilizada [get e set]
		 */
		public void Usuario() {
			return bairro;
		}

		/**
		 * Retorna o bairro do usuário.
		 * 
		 * @return bairro <code>String</code>
		 */
		public String getBairro() {
			return bairro;
		}

		/**
		 * Define o bairro do usuário
		 * 
		 * @param bairro
		 *            <code>String</code>
		 */
		public void setBairro(String bairro) {
			this.bairro = bairro;
		}
	}

alguém sabe como fazer o javadoc para atributos??

como eu documento um

public static String SERVER_IP = "192.168.0.111";

??

C

Boa Tarde

Na minha aplicação para atributos eu uso a seguite sintaxe do javadoc:

/**

  • Array com os digitos hexadecimais
    */
    private static String[] hexDigits = {“0”,“1”,“2”,“3”,“4”,“5”,“6”,“7”,“8”,“9”,“a”,“b”,“c”,“d”,“e”,“f”};

Agora com relação ao javadoc para métodos ou uso assim:

/**
 * Método de Envio de E-Mails em formato HTML - emailHtml
 * 
 * @since  05/05/2008
 * 
 * @param  String destinatario  - Destinatario do E-Mail
 * @param  String assunto        - Assunto do E-Mail
 * @param  String mensagem   - Mensagem do E-Mail
 * @return boolean
 * @throws EmailException
 * @throws FactoryException
 */

Falou…

everson_z
everson_z

erickcellani:
intaum cara… enquanto ao javadoc… está errado…

eu vi que vc está usando @param para qualquer coisa… e naum é certo… vc deve usa-lá se vc tiver que passar um parametro mesmo…
exemplo:

espero ter ajudado!

Vou tomar…
Só isso, eu deixo os @param apenas para as exigências da estrutura?
E sobre a duvida 1 ?

everson_z

Essa

/**String - Armazena a constante driver de conexão*/
 	private final String DRIVER = "com.mysql.jdbc.Driver";
everson_z

O javabean fica assim?

/** Classe de atributos
 * @author Everson
 * @since 18/04/2007
 */
public class Usuario {
    
         private String bairro

	/**
	 * @return bairro String
	 */
	public String getBairro() {
		return bairro;
	}
	/**
	 * @param bairro String
	 */
	public void setBairro(String bairro) {
		this.bairro = bairro;
	}
}
Criado 18 de abril de 2007
Ultima resposta 18 de abr. de 2007
Respostas 10
Participantes 5