Estructura del directorio de control de fuente recomendada?

Question

Voy a utilizar Subversion para el control de fuente en una nueva aplicación web J2EE. ¿Qué estructura de directorios recomendarás para organizar el código, las pruebas y la documentación?

Answer 1

por lo general tienen

 
Project Directory 
    src - actual source 
    doc - documentation 
    lib - libraries referenced from source 
    dep - installation files for dependencies that don't fit in lib 
    db - database installation script 

En el trabajo con Visual Studio, no estoy seguro si esto funciona de la misma en el mundo Java. Pero normalmente pongo cosas en diferentes carpetas de proyectos en src. Para cada proyecto fuente hay un proyecto de prueba por separado. Los archivos de compilación van en el directorio principal del proyecto. Normalmente pongo un LÉAME allí también, documentando cómo configurar el proyecto si necesita algo más que solo echarle un vistazo.

EDITAR: Esta es la estructura para una sola comprobación de trabajo del proyecto. Se duplicará para cada rama/etiqueta en su sistema de control de revisiones (recuerde, en la mayoría de los sistemas SVN, las copias son baratas). El ejemplo anterior en virtud de la subversión se vería así:

/project 
    /trunk 
     /src 
     /doc 
     /... 
    /branches 
     /feature1 
      /src 
      /doc 
      /... 
     /feature2 
      /src 
      /doc 
      /... 

Answer 2

he encontrado algunas viejas preguntas aquí en lo que podría ser de su interés:

• Whats a good standard code layout for a php application
  • contiene un enlace a un artículo sobre Scalable and Flexible Directory Structure for Web Applications (foco en PHP, sin embargo)
• How to structure a java application, in other words: where do I put my classes?
• Structure of Projects in Version Control

Answer 3

que utilizar Eclipse para crear aplicaciones web J2EE y esto va a crear la siguiente estructura del proyecto:

WebAppName\ 
    \lib 
    \src 
    \tests 
    etc... 

me permitiría crear una carpeta SVN en nuestro tronco llamado WebAppNameProject. Dentro de esta carpeta, crearía carpetas llamadas WebAppNameSource, Documentation, etc. Dentro de la carpeta WebAppNameSource colocaría el origen del proyecto generado por Eclipse. Por lo tanto, tendría la siguiente estructura de carpetas en SVN:

\svn\trunk\WebAppNameProject 
    \WebAppNameSource 
     \lib 
     \src 
     \tests 
     etc... 
    \Documentation 

Espero que esto ayude.

Answer 4

Para ampliar lo sugerido por Mendelt Siebenga, también agregaría un directorio web (para archivos JSP, WEB-INF, web.xml, etc.).

Las pruebas deben ir en una carpeta denominada test que es un hermano de la carpeta principal src - de esta manera las clases de prueba unitarias pueden tener el mismo nombre que el código fuente que se está probando (para facilitar las situaciones en las que desea probar métodos o clases protegidos, por ejemplo ... ver JUnit FAQ for this, y esta pregunta también en Where should I put my test files?).

No he tenido demasiado uso para esto, pero un proyecto Maven también creará una carpeta resources junto con la carpeta src para código no fuente que desee empaquetar/implementar junto con el código fuente principal - cosas como como archivos de propiedades, paquetes de recursos, etc. Su millaje puede variar en este caso.