Tabla de contenidos
- D.1. Resumen
- D.2. Formato de los archivos de documentación
- D.2.1. Etiquetas XML
- D.2.2. Longitud máxima de línea
- D.2.3. Sangría
- D.2.4. Terminación de línea
- D.2.5. Etiquetas vacías
- D.2.6. Uso de los espacios en blanco dentro de los documentos
- D.2.7. Listados de programa
- D.2.8. Notas sobre etiquetas en línea específicas
- D.2.9. Notas sobre etiquetas de bloque específicas
- D.3. Recomendaciones
Este documento proporciona directrices para la creación de la documentación de usuario final que se encuentra dentro de Zend Framework. Está pensado como una guía para los colaboradores de Zend Framework, quienes deben escribir documentación como parte de sus contribuciones a los componentes, así como para los traductores de la documentación. Los estándares aquí contenidos tienen como objetivo facilitar la traducción de la documentación, minimizar las diferencias visuales y de estilo entre los distintos archivos de documentación, y facilitar la búsqueda de cambios en la documentación con herramientas de diff.
Puede adoptar y/o modificar estos estándares de acuerdo con los términos de nuestra licencia.
Los temas cubiertos en los estándares de documentación de Zend Framework incluyen el formato de los archivos de documentación y recomendaciones para la calidad de la documentación.