This wiki does not contain official documentation and is currently deprecated and read only. Please try reading the documentation on the Liferay Developer Network, the new site dedicated to Liferay documentation. 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

Dettagli Stampa
Tag: understanding and improving liferay javadoc javadocs

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

0 Allegati
192495 Visualizzazioni
Media (3 Voti)
La media del punteggio è 5.0 stelle su 5.
Commenti
Commenti Autore Data
Thank you for this guide! If only all Liferay's... Nicolas Forney 20 luglio 2011 0.36
Thanks a lot for exelect guide of how to write... Roman Ivanov 29 novembre 2014 21.20

Nicolas Forney
Thank you for this guide!
If only all Liferay's classes could follow those guidelines...
Inviato il 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.
Inviato il 29/11/14 21.20.