Comunitat DSTSC

1. Prerequisits

• Tenir instal·lat l’entorn corporatiu
• Tenir un projecte descarregat a l’entorn (veure document descarregar projecte o crear projecte backoffice)

2. Creació del site

Per crear la documentació del site, agafem com a exemple el codi de projecte XXX.

Nota: Aquesta acció pot trigar uns 5 minuts

Això genera la documentació a la carpeta /target del projecte. S’ha de copiar manualment la carpeta site sencera per no perdre-la

3. Definició dels moduls del site

La configuració del site està definida al pom.xml a la secció de report
Cada report que es descriu a continuació

3.1. Contingut personalitzat

Per poder personalitzar més l’aparença i el contingut del site, es pot afegir opcionalment una plantilla. Això està fet, definint una carpeta site i un fitxer site.xml es defineix automàticament la plantilla del site. Aquest fitxer es configura per afegir la capçalera amb estils de l’aplicació i enllaços a la carpeta del projecte i als entorns de desenvolupament. És totalment configurable.
També es poden afegir noves planes amb uns formats específics:

• FML: Format tipus FAQ.
• APT: Format tipus wiki: S’afegeix una plana al FAM a mode exemple ()

Al FAM a mode exemple s’afegeix FAQ.fml i dibaInfo.apt i s’enllacen al site.xml (menú informació)

3.2. Modul ‘Codi referenciat’ (Xref)

Aquest informe exporta tot el codi font en un format que sigui referenciable per línia. D’aquesta manera s’integra amb altres plugins que fan referència a alguna línia de codi en concret.

3.3. Modul ‘Checkstyle’

Aquest informe genera la revisió de codi amb checkstyle. Es comproven normes d’estil o de format del codi, com ara que es facin servir noms de variables correctes, que estigui tot documentat amb javadoc, l’ús correcte del nivell d’accés a les variables...
L’informe mostra un resum dels warnings que s’han generat linkable amb el codi font Xref.

Nota: S’ha de reduir al màxim aquests avisos, però no ha de ser una obsessió deixar a zero aquest informe. De vegades hi ha warnings justificables o que en intentar resoldre’ls s’afegeix una complexitat innecessària al codi.

3.4. Modul ‘Tasques pendents’ (TagList)

Aquest informe genera un resum de les tasques (FIXME, TODO, DIBA_REV i totes les que es defineixin) que queden pendents de fer. Al codi es marquen com tasques a revisar i el plugin fa un resum de les que queden obertes.

3.5. Modul ‘PMD’

Aquest informe genera la revisió de codi amb PMD. Es comproven regles de codificació per evitar fer dissenys de poca qualitat. L’informe mostra un resum dels warnings i errors que s’han generat linkable amb el codi font Xref.

Nota: Igual que al checkstyle, s’ha de reduir al màxim aquests avisos, però no ha de ser una obsessió deixar a zero aquest informe.

3.6. Modul ‘Find bugs’

Aquest informe genera la revisió de codi amb Findbugs. Es cerquen possibles bugs d’aplicació o trossos de codi que puguin generar problemes. L’informe mostra un resum dels warnings i errors que s’han generat linkable amb el codi font Xref.

3.7. Modul ‘SVN Changelog’

Aquest informe mostra un llistat dels canvis fets a subversion a l’últim mes (configurable). Apareix la versió, usuari i data del canvi, el comentari que ha afegit el desenvolupador i els fitxers afectats. L’informe està enllaçat amb urls de svn.

Nota: És importatnt afegir comentaris en pujar codi al subversion per poder fer un bon seguiment de l’estat del projecte.

3.8. Modul ‘Javadoc’

Aquest informe genera la documentació javadoc.

3.9. Modul ‘Unit test’ (Surefire)

Aquest informe genera un resum dels tests que s’han executat pel projecte.

3.10. Modul ‘Jdepend’

Aquest informe genera tot un seguit d’estadistiques en relació a la estructuració del codi (encapsulament, abstraccio...)

Nota: Aquest informe és de caire més tècnic i s’ha de fer un estudi ‘avançat’ per poder treure informació d’interés..