Foros de discusión
Improve inline documentation
Roland Blochberger, modificado hace 15 años.
Improve inline documentation
New Member Mensajes: 7 Fecha de incorporación: 3/09/08 Mensajes recientes
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
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
Lisa Simpson, modificado hace 14 años.
RE: Improve inline documentation
Liferay Legend Mensajes: 2034 Fecha de incorporación: 5/03/09 Mensajes recientes
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....