Configurar proyecto en Subversion para completar PHPDocumentor

In: php

7 jul 2010

Logo de PHPDocumentorUna de las partes importantes de un proyecto es la documentación, y me refiero a la documentación técnica y no a los manuales de usuario. De cara a nuevos proyectos, al principio se puede plantear la opción de utilizar PHPDocumentor para hacer la documentación de los ficheros de una manera estándar, y con la potencia que da para http://es.wikipedia.org/wiki/PhpDocumentor de la aplicación. Todo y eso, sigue habiendo el problema que la acción de documentar es muy tedioso para los desarrolladores y nunca apetece dedicar tiempo.

Su pueden configurar los proyectos que estén en un Subversion, para que en cada commit, el repositorio modifique valores dentro de las cabeceras de PHPDocumentor que hay en el código de los ficheros modificados. Esto solamente funciona en archivos (con extensiones como . o .phtml), y requieren tener una cabecera similar a la siguiente:

 
Estos ficheros hay que <strong>añadirles una propiedad de Subversion</strong>: <em>svn-keywords</em>. El valor que necesita esta propiedad es:
 
 
<pre lang="php">Author Date Rev Id

Así, Subversion buscará los campos de la cabecera que puede rellenar, y introducirá los valores que pertoquen, según el commit. En las siguientes modificaciones, irá actualizando los valores si es que se han realizado cambios en el fichero.

Entradas relacionadas:

  1. Guía para crear documentación con PHPDocumentor
  2. Configurar Subversion para utilizar los repositorios externos de Zend Framework
  3. Configurar PHP para que muestre los errores
  4. Configurar XAMPP para debugar con XDebug en Netbeans
  5. Configurar Netbeans para trabajar con PHPUnit y Zend Framework

1 Comentario en Configurar proyecto en Subversion para completar PHPDocumentor

Guía para crear documentación con PHPDocumentor | Otro Blog Más

16 agosto 2010 a las 08:12

[...] una entrada anterior se mostró como configurar un proyecto en Subversion para completar el PHPDocumentor, pero no se entró en muchos detalles del PHPDocumentor. Esta guía pretende adentrarse un poco [...]

Formulario de Comentario

Página 1 de 11

Sobre este blog

Este blog informático pretende ser un blog de notas o portafolio de información variada: trozos de código, descubrimientos, notas sueltas, ... Para tenerla a mano, y ser compartida.