Quiero que cuando pase el mouse sobre un método, pueda ver mi documentación de lo que hace el método cuando pongo el mouse sobre el método de Java. Sé que / ** * / es cómo se hace, pero:
¿Cómo explicas lo que significa Params?
¿Cómo creas una nueva línea, o haces una palabra en negrita o cursiva?
Si está utilizando Eclipse como IDE, solo necesita crear un comentario con
/** y presione Entrar y generará su código para su Javadoc, incluidos los parámetros, los valores de retorno, etc. Solo necesita poner las descripciones.
Lo mismo se aplica a las declaraciones de clase (el comentario Javadoc siempre se relaciona con el siguiente elemento)
Nota:
Para adjuntar doc a su método, debe 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 */
¿Cómo explicas lo que significa Params?
Use la etiqueta @param :
/** * @param paramName Explanation of the param */ public void foo(String paramName);
¿Cómo creas una nueva línea, o haces una palabra en negrita o cursiva?
Utilice HTML estándar, es decir,
, y (o menos semántico y )