Tool for autogenerating java doc compliant documentation in source code.
Hi all,
My apologies, I did not know about this forum and previously posted this query in java programming forum too but had no replies and thus posting here.
There are tons of java classes in my current project that have zero documentation at class and method level.
I tried using javadoc tool for generating java docs for these classes but was not helpful in terms of knowing the PURPOSE of the class/method.
It is being a tedious task to hand write the class/method level documentation/purpose. Thus wondering if there is any feature in javadoc tool that intutively auto generates the 'java doc complaint documentation blocks' within the class ALONG with the PURPOSE of the method/class by understanding the code?
Example: I want the tool to generate the following block for a method in the source code as follows:
code:
--
/***
* This method handles the CRUD requests.
* @param XXX
* @return YYY
* @throws ZZZ
* @see xyz.x.y.z
*/
public void x(int z ) throws Exception;
--
If there is no such feature in javadoc tool, do you suggest any other open source utility tool that serves my purpose?
Any help is HIGHLY appreciated.
Thanks a ton in advance.
