Document Actions
Política de uso del inglés en los fuentes
| Autor: | Jorge Sanz |
|---|---|
| Fecha: | 10.07.2009 |
| Estado: | Aprobada en reunión presencial |
| Prioridad: | Normal |
Esta propuesta se aprobó por unanimidad en la reunión presencial del Board del CDT del 29 de julio
Motivación y objetivo
El objetivo de esta propuesta es definir de forma explícita la política del idioma a utilizar por los desarrolladores en el código fuente de los proyectos desarrollados en el proyecto.
Note
Esta propuesta tiene caracter de recomendación para los desarrollos contribuidos al proyecto.
Note
Esta propuesta no cubre la documentación de usuario o técnica de gvSIG, sólo los fuentes.
Equipo de trabajo
No procede
Propuestas a las que modifica
Esta propuesta no modifica a ninguna otra anterior.
Modificaciones a esta propuesta
No hay modificaciones a esta propuesta.
Descripción de la propuesta
Qué aspectos se contemplan como documentación en el código fuente de gvSIG:
- Identificadores java:
- nombres de clase
- paquetes
- atributos
- métodos
- Javadocs
- Comentarios dentro del código fuente
Identificadores java
Serán siempre en inglés.
Comentarios
No se obliga a usar el inglés, pero se recomienda encarecidamente.
Javadocs
Se distinguirán dos casos:
- La documentación de las API será siempre en inglés
- En la implementación se exigirá que existan los javadocs, recomendando encarecidamente el uso del inglés.
Justificación de votos negativos
No ha sido necesaria la justificación de los votos en contra de la propuesta.
