Solved

tool to find missing documentation in Java Project

Posted on 2004-09-22
13
216 Views
Last Modified: 2010-03-31
I have a java project. I am supposed to find out all the classes, constructors, methods and attributes in each file which are not documentated. I tried doing manually, but its taking lot of time ( there are about 40 packages).
Is there any tool which can find missing documentation for each file in the project.
0
Comment
Question by:thomas908
  • 6
  • 3
  • 2
  • +2
13 Comments
 
LVL 21

Expert Comment

by:MogalManic
Comment Utility
Look into jalopy (http://jalopy.sourceforge.net/).  It is a code formatter that autogenerates javadoc.  You can install it as a plugin for eclipse and format whole packages at a time.  Then do a global search for "DOCUMENT ME!".
0
 
LVL 8

Author Comment

by:thomas908
Comment Utility
I need a plugin for JBuilder
0
 
LVL 8

Author Comment

by:thomas908
Comment Utility
I think is generates javadoc, but does it tell about the missing documentation. Say in any file i have not given any documentation for class, method abc() and xyz() and attribute a.
I need a tool which tells me this.
0
 
LVL 21

Expert Comment

by:MogalManic
Comment Utility
You can configure jalopy to comment even to the attribute level.  It will correct the method @param comments as well.   It won't generate the comments for you, you still have to understand the code and put meaningfull comments.  It will put in the

There is a JBuilder integration module as well.  I assume it works like the eclipse plug-in.
0
 
LVL 8

Author Comment

by:thomas908
Comment Utility
i don't need to generate comments, I just need to a sort of report which will show where the comments are missing (in which file for which class, method, attribute, constructor). I dont need to generate comments.
0
 
LVL 12

Expert Comment

by:Giant2
Comment Utility
I believe you must create one your own.
Bye, Giant.
0
What Is Threat Intelligence?

Threat intelligence is often discussed, but rarely understood. Starting with a precise definition, along with clear business goals, is essential.

 
LVL 12

Accepted Solution

by:
Giant2 earned 450 total points
Comment Utility
You can use, I think, Doclet.
See here!
http://java.sun.com/j2se/javadoc/doccheck/index.html

Giant.
0
 
LVL 12

Expert Comment

by:Giant2
Comment Utility
download it, install it and type:
jvadoc -doclet <doclet-name>

I believe this is what you need.

Bye, Giant.
0
 
LVL 12

Expert Comment

by:Giant2
Comment Utility
javadoc -doclet <doclet-name>
0
 
LVL 12

Expert Comment

by:Giant2
Comment Utility
in particular:
put the jar file of doccheck in your jdk lib directory (I have c:\jdk1.4\ for the jdk)
type:

set classpath=%classpath%;c:\jdk1.4\lib\tools.jar;c:\jdk1.4\lib\doccheck.jar

javadoc -doclet com.sun.tools.doclets.doccheck.DocCheck yourJavaFilesOrDirectory

And then, enjoy!!

This produce all you want.
Bye, Giant.
0
 
LVL 7

Assisted Solution

by:grim_toaster
grim_toaster earned 50 total points
Comment Utility
I use JCSC to this kind of thing, it can be used for general coding standards issues as well, and can/should be integrated into the build process:

http://jcsc.sourceforge.net/

It is fully customisable (there are over 100 rules in the latest edition), and if you are only after the javadoc rules, then only include them.  I also believe that you can get a plugin for most IDE's for it.
0
 
LVL 24

Expert Comment

by:sciuriware
Comment Utility
I think those suggestions are good.
Besides, I believe there is a JBuilder plugin for JRefactory (on the same website)
You can tell it to put dummy comments of various type in all places where it's needed.
Another approach is to download ECLIPSE 3.1 and tell it to complain about missing comments.
Then take up your sources, let ECLIPSE look at it and use Ctrl/1 where ever to add your comments,
then take your sources back to JBUILDER.
;JOOP!
0
 
LVL 12

Expert Comment

by:Giant2
Comment Utility
Thanks.
Happy to help you.
:)
0

Featured Post

Find Ransomware Secrets With All-Source Analysis

Ransomware has become a major concern for organizations; its prevalence has grown due to past successes achieved by threat actors. While each ransomware variant is different, we’ve seen some common tactics and trends used among the authors of the malware.

Join & Write a Comment

Suggested Solutions

After being asked a question last year, I went into one of my moods where I did some research and code just for the fun and learning of it all.  Subsequently, from this journey, I put together this article on "Range Searching Using Visual Basic.NET …
Java Flight Recorder and Java Mission Control together create a complete tool chain to continuously collect low level and detailed runtime information enabling after-the-fact incident analysis. Java Flight Recorder is a profiling and event collectio…
Viewers will learn about basic arrays, how to declare them, and how to use them. Introduction and definition: Declare an array and cover the syntax of declaring them: Initialize every index in the created array: Example/Features of a basic arr…
This tutorial covers a step-by-step guide to install VisualVM launcher in eclipse.

763 members asked questions and received personalized solutions in the past 7 days.

Join the community of 500,000 technology professionals and ask your questions.

Join & Ask a Question

Need Help in Real-Time?

Connect with top rated Experts

9 Experts available now in Live!

Get 1:1 Help Now