DISCOVER Build your web site, collaborate with your colleagues, manage your content, and more. DEVELOP Build applications that run inside Liferay, extend the features provided out of the box with Liferay's APIs. DISTRIBUTE Let the world know about your app by publishing it in Liferay's marketplace. PARTICIPATE Become a part of Liferay's community, meet other Liferay users, and get involved in the open source project.

Wiki

Javadoc Guidelines

Detalles

Imprimir

The guidelines have been moved permanently to https://dev.liferay.com/participate/javadoc-guidelines.

0 archivos adjuntos

192974 Accesos

Promedio (3 Votos)

Comentarios

Respuestas anidadas	Autor	Fecha
Thank you for this guide! If only all Liferay's...	Nicolas Forney	20 de julio de 2011 0:36
Thanks a lot for exelect guide of how to write...	Roman Ivanov	29 de noviembre de 2014 21:20

Nicolas Forney

Thank you for this guide!
If only all Liferay's classes could follow those guidelines...

Autentíquese para votar.

Arriba

Publicado el día 20/07/11 0:36.

Roman Ivanov

Thanks a lot for exelect guide of how to write javadoc!

This document inspired Checkstyle(http://checkstyle.sourceforge.net/) team to provide detailed Javadoc support parsing base on grammar.
Writing a validation rules(Checks) to enforce all that rules/guidelines becomes a easy task.
Checkstyle already covers Google's recomendations for Javadoc.

If somebody intersted in creation automating validation for this guide - please be welcome to Checkstyle mail-list.

Autentíquese para votar.

Arriba

Publicado el día 29/11/14 21:20.