Design patterns are widely recognized as important software development methods. Their use as software understanding tools, though generally acknowledged, has been scarcely explored. Patterns are most useful in understanding software when they are well documented. Sometimes they are described separately from code as design comments. Nevertheless, they have a strong relationship with the source code and thus they should also be documented at the source level. Unfortunately, there is no agreement on how to document pattern use. This paper describes a structured approach to documenting pattern use in the Java language. Our solution is based on the standard Javadoc tool and is able to generate HTML documentation. The approach has been implemented and tested with software that uses patterns.

Documenting Pattern Use in Java Programs / Torchiano, Marco. - STAMPA. - (2002), pp. 230-233. (Intervento presentato al convegno IEEE International Conference on Software Maintenance (ICSM 2002) tenutosi a Montreal, Canada nel October 3-6) [10.1109/ICSM.2002.1167770].

Documenting Pattern Use in Java Programs

TORCHIANO, MARCO
2002

Abstract

Design patterns are widely recognized as important software development methods. Their use as software understanding tools, though generally acknowledged, has been scarcely explored. Patterns are most useful in understanding software when they are well documented. Sometimes they are described separately from code as design comments. Nevertheless, they have a strong relationship with the source code and thus they should also be documented at the source level. Unfortunately, there is no agreement on how to document pattern use. This paper describes a structured approach to documenting pattern use in the Java language. Our solution is based on the standard Javadoc tool and is able to generate HTML documentation. The approach has been implemented and tested with software that uses patterns.
2002
0769518192
File in questo prodotto:
Non ci sono file associati a questo prodotto.
Pubblicazioni consigliate

I documenti in IRIS sono protetti da copyright e tutti i diritti sono riservati, salvo diversa indicazione.

Utilizza questo identificativo per citare o creare un link a questo documento: https://hdl.handle.net/11583/1418513
 Attenzione

Attenzione! I dati visualizzati non sono stati sottoposti a validazione da parte dell'ateneo