如何创建我的代码摘要

Question

I want to automatically create some sort of report of my code(java). Example: I have something like:

public classe qwerty{
//CODE
/*
* Converts ...
* @param s
*        -string...
*/
public static int mult(string s)
   {
   //CODE
   } 
}

And I want to create something that looks like this:

...............................
public static int mult(string s)
Converts ...

Paramters:
   s (String): string...
Returns (int)
.................................
ETC

Is there any tool for that??

Answer 1

Maybe you are searching for javadoc

Javadoc creates html-files of your code as a documentation. Just look at some tutorial

Answer 2

If you have looked at javadoc, and it is not suitable for you, then look at this solution

How to read Javadoc comments by reflection?

look at answer "doclet"

Answer 3

If you are using IntelliJ then before the method you want to comment you have to type / ** and hit enter. It automatically creates a comment with params or without depending on your function.