Tuesday, September 27, 2005

Como escribir comentarios para la documentación con el Javadoc

How to Write Doc Comments for the Javadoc Tool

Este es un tutorial de la convenciones usadas para la creación de comentarios en los programas que creamos en los projectos. Este documentación es importante porque será utilizado por otros programadores (y en algunos casos por nosostros mismos), para el desarrollo.

Este documento trara de como crear la documentación para que el javadoc pueda crear una documentación de nuestro código de manera correcta (como la del API de J2SE por ejemplo).

Obviamente el tutorial esta en ingles.

http://java.sun.com/j2se/javadoc/writingdoccomments/index.html

No comments: