Forums de discussion

Improve inline documentation

thumbnail
Roland Blochberger, modifié il y a 15 années.

Improve inline documentation

New Member Publications: 7 Date d'inscription: 03/09/08 Publications récentes
Liferay is open source but if you look at the sources they are not significant better to read than any JAD output.

In my recent projects I found it very useful to activate Eclipse's Javadoc checks to recognize undocumented classes and methods. It also helps to update the Javadoc tags after some refactoring actions.

Even if I ignore the original Liferay sources, the service builder generates sources without method-Javadoc, so I get a lot of warnings from Eclipse if I switch on the Javadoc checks there in my own project.

Regards,
Roland
thumbnail
Lisa Simpson, modifié il y a 14 années.

RE: Improve inline documentation

Liferay Legend Publications: 2034 Date d'inscription: 05/03/09 Publications récentes
The on-line documentation needs work! Like moving some stuff from the forums into the wiki.... and having a wiki that the community can contribute to but that is moderated by the Liferay staff....