How to create a summary of my code

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??

Have you looked at javadoc? If not, it is probably the tool you are looking for. — Patricia Shanahan, Dec 16 '12 at 23:37
http://stackoverflow.com/questions/225447/doxygen-vs-javadoc — ChrisW, Dec 16 '12 at 23:37
I believe that the Eclipse IDE assists you in creating JavaDocs, a documentation format for Java code. You just need to type `/**` to start the documentation comment block AFTER you write the method. — recursion.ninja, Dec 16 '12 at 23:38

score 2 · Answer 1 · answered Dec 16 '12 at 23:39

2

Maybe you are searching for javadoc

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

answered Dec 16 '12 at 23:39

Link

1,307
1
11
23

After reading this it is inded what I want but can it make a Word document? – Joao Silva Dec 16 '12 at 23:52
No; why would you want that? – Louis Wasserman Dec 17 '12 at 00:43
There used to be MIF Doclet for PDF purposes – Usman Saleem Dec 17 '12 at 00:49
@LouisWasserman Because I already have the report in Word I just need to add the functions and constructor etc. – Joao Silva Dec 17 '12 at 01:15

score 0 · Answer 2 · edited May 23 '17 at 12:04

0

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"

edited May 23 '17 at 12:04

Community

1
1

answered Dec 17 '12 at 00:20

AlexWien

28,470
6
53
83

score 0 · Answer 3 · answered Dec 01 '21 at 15:07

0

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.

answered Dec 01 '21 at 15:07

Layon

1
1

How to create a summary of my code

3 Answers3