Saturday, October 29, 2011

ADF : Create Help Library using javadoc

For every software application creating help document for all functions and methods is most important thing for future reference.

Fortunately and very thanks to Oracle ADF Framework development team for providing help comment by default in Oracle ADF BC Impl files.

Here is following example of  EntityImpl.java files.

Normal Comment

Normal comment in java begin with /* and ends with */ and every thing between this two is ignored by compiler.

Javadoc

A javadoc comment begin with /** and end’s with */ and every thing between this two is ignored by compiler.Please create simple ADF BC project and generate Java files for EO , VO object.

To generate documentation we just have to run following command.

javadoc DepartmentsImpl.java

It will generate Help file just like Java Documentation online.

image

No comments:

Post a Comment