How to document my method in Java like Java docs?

Question

I want that when i mouse over a method i would be able to see my documentation of what the method does like when i put the mouse over Java's method I know that /** */ is how its done but:

How do you explain what the Params Stands for?
How do you create a new line, or make a word bold or italic?

Please read the [docs](http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html) — pb2q, Aug 01 '12 at 16:43

score 36 · Accepted Answer · edited Dec 16 '19 at 05:04

36

In most major IDEs, such as IntelliJ's IDEA, Apache Netbeans or Eclipse; you can type

/**

and press enter and it will generate the Javadoc for your method, including parameters, return values, etc. You just need to put in the descriptions.

The same applies for class declarations (the Javadoc comment always relates to the following element)

For instance

/**
 * create_instance
 * @param array of attributes for instance containing web, db, arrival_rate, response_time for instance 
 * respectively.
 * @return Instance object
 */

edited Dec 16 '19 at 05:04

otoomey

939
1
14
31

answered Aug 01 '12 at 17:01

Peter Ilfrich

3,727
3
31
35

In Deed, very often used Feature – Jan Galinski Aug 01 '12 at 19:22
1

You can do the same thing for intelliJ – Simon Oct 07 '15 at 12:22
You don't need to specify the method name at the top of the comment. It wiil work with or with out it. – Federico Alvarez Dec 27 '17 at 17:35

score 26 · Answer 2 · answered Aug 01 '12 at 16:44

How do you explain what the Params Stands for?

Use @param tag:

/**
 * @param paramName Explanation of the param
 */
public void foo(String paramName);

How do you create a new line, or make a word bold or italic?

Use standard HTML, i.e. ,  ,  and  (or less semantic  and )

How to document my method in Java like Java docs?

2 Answers2

Linked

Related