Object-oriented Software Documentation

Software documentation provides software developers and users with a useful description of what the software does, how it works, how it's built, and how it's supposed to be used. For instance, a user manual demonstrates how users should interact with a software product; while the design document helps developers during software evolution and maintenance. The main challenge is to construct automated tool that can produce, on-demand, a dynamic documentation of software source code. This book presents an automatic approach called Al-Msie'deen approach to generate on-demand software documentation for software code. The novelty of this approach lies in the production of dynamic software code documentation at package, class, attribute, and method levels. Code documentation is a written text or illustrated diagrams that present information about all levels of code granularity, from packages level down to methods level. Al-Msie'deen approach generates different kinds of code documentation such as code summaries, labels, metrics, tag clouds, and graphics documents. Code documents make information on software code more accessible to developers and cheaper to create.