Documentação de software orientado a objetos

A documentação do software fornece aos desenvolvedores de software e usuários uma descrição útil do que o software faz, como funciona, como é construído e como deve ser usado. Por exemplo, um manual do usuário demonstra como os usuários devem interagir com um produto de software; enquanto o documento de design ajuda os desenvolvedores durante a evolução e manutenção do software. O principal desafio é construir uma ferramenta automatizada que possa produzir, sob demanda, uma documentação dinâmica do código fonte do software. Este livro apresenta uma abordagem automática chamada abordagem Al-Msie'deen para gerar documentação de software on-demand para código de software. A novidade desta abordagem reside na produção de documentação dinâmica de código do software a nível de pacote, classe, atributo e método. Documentação de código é um texto escrito ou diagramas ilustrados que apresentam informações sobre todos os níveis de granularidade de código, desde o nível de pacotes até o nível de métodos. A abordagem Al-Msie'deen gera diferentes tipos de documentação de código, tais como sumários de código, etiquetas, métricas, nuvens de etiquetas, e documentos gráficos.