An Experimental Evaluation of Documentation Methods and Reusability

This paper presents an experimental evaluation carried out in an academic environment. The goal of the experiment was to compare how different methods of documenting semantic information affect software reuse. More specifically, the goal was to measure if there were any differences between the methods with regard to the time needed to implement changes to existing software. Four methods of documentation were used; executable contracts, non-executable contracts, Javadoc-style documentation and sequence diagrams. The results indicate that executable contracts demanded more time than the other three methods and that sequence diagrams and Javadoc demanded the least time.

[1]  R. Kramer iContract - The Java(tm) Design by Contract(tm) Tool , 1998 .

[2]  Sushil Jajodia,et al.  Conceptual Modeling — ER 2001 , 2001, Lecture Notes in Computer Science.

[3]  簡聰富,et al.  物件導向軟體之架構(Object-Oriented Software Construction)探討 , 1989 .

[4]  Martin Blom,et al.  An experimental evaluation of programming by contract , 2002, Proceedings Ninth Annual IEEE International Conference and Workshop on the Engineering of Computer-Based Systems.

[5]  Guy L. Steele,et al.  The Java Language Specification , 1996 .

[6]  Leon G. Higley,et al.  Forensic Entomology: An Introduction , 2009 .

[7]  Bertrand Meyer,et al.  Object-Oriented Software Construction, 2nd Edition , 1997 .

[8]  Matthias Felleisen,et al.  Contract Soundness for object-oriented languages , 2001, OOPSLA '01.

[9]  Alistair Cockburn Object-oriented analysis and design, part 2. , 1998 .

[10]  Sidney Addelman,et al.  trans-Dimethanolbis(1,1,1-trifluoro-5,5-dimethylhexane-2,4-dionato)zinc(II) , 2008, Acta crystallographica. Section E, Structure reports online.

[11]  Il-Yeol Song,et al.  Developing Sequence Diagrams in UML , 2001, ER.

[12]  Ivar Jacobson,et al.  The Unified Software Development Process , 1999 .