Quiero que cuando muevo el mouse sobre un método, pueda ver mi documentación de lo que le gusta al método cuando coloco el mouse sobre el método de Java, sé que/** */es como se hace, pero:¿Cómo documentar mi método en Java como documentos Java?
¿Cómo se explica a qué se refieren los Params?
¿Cómo se crea una nueva línea, o se hace una palabra en negrita o cursiva?
Si utilizas Eclipse como IDE, sólo tiene que crear un comentario con
/**
y presiona enter y generará tu código para tu Javadoc, incluyendo parámetros, valores de retorno, etc. Solo tienes que poner las descripciones.
Lo mismo se aplica para las declaraciones de clase (el comentario Javadoc siempre se relaciona con el elemento siguiente)
Nota:
Para adjuntar documento a su método es necesario especificar el nombre del método en los comentarios en la parte superior .
Por ejemplo
/**
* create_instance
* @param array of attributes for instance containing web, db, arrival_rate, response_time for instance
* respectively.
* @return Instance object
*/
agradable! !!!!!!!!!!!! –
De hecho, se usa muy a menudo Característica –
Puede hacer lo mismo para intelliJ – Simon
¿Cómo se explica lo que el Parámetros representa?
Uso @param etiqueta:
/**
* @param paramName Explanation of the param
*/
public void foo(String paramName);
¿Cómo crea una nueva línea, o hacer una palabra en negrita o cursiva?
usar HTML estándar, es decir <p></p>, <br/>, <strong> y <em> (o menos semántica <b> y <i>)
Lea los documentos [] (http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html) – pb2q