A Model-Driven Software Reuse Approach (in portuguese)

164
Asset Specifications ou Especificações de Artefatos Reutilizáveis) (VOTH, 2004). Estes podem
ser úteis para a documentação de diferentes tipos de software. Com base nestes e em outros
trabalhos relacionados à documentação de componentes (SILVA; WERNER, 1996; KOTULA, 1998;
TAULAVUORI; NIEMELA; KALLIO, 2004; BASILI; ABD-EL-HAFIZ, 1996), a presente abordagem
propõe um formato específico para a documentação, além de alguns princípios:
P1. Hipertexto. O hipertexto mostrou-se uma técnica eficiente para a documentação. Por
exemplo, ajuda a aumentar o conhecimento que engenheiros de software adquirem ao percorrer
repositórios de componentes de software (ISAKOWITZ; KAUFFMAN, 1996). Também facilita o
processo de navegação através da informação, além de ser um formato já familiar à maioria dos
usuários. Assim, sempre que possível, a documentação deve ser apresentada como hipertexto.
P2. Comentários embutidos no código-fonte. A documentação deve estar sempre
consistente e atualizada com relação ao código-fonte. Embutindo-se a documentação no
código-fonte, é mais fácil atualizá-la sempre que forem feitas mudanças no código, já que
ambos estão no mesmo lugar;
P3. Automação. No contexto do MDD, é possível gerar, junto com código, diferentes
tipos de artefatos, incluindo documentação. Assim, sempre que possível, deve-se automatizar a
geração de documentação para livrar o desenvolvedor deste tipo de trabalho manual;
P4. Utilize a semântica da linguagem. Muitas construções da própria linguagem de
programação contém informação útil à reutilização de software. Por exemplo, a comparação de
assinatura (ZAREMSKI; WING, 1995) analisa a própria definição das interfaces para determinar
se um componente pode ser reutilizado em um determinado contexto. Também é possível, por
exemplo, determinar algumas características de um componente examinando-se o código-fonte,
até mesmo de forma automática. Assim, a documentação deve utilizar todo tipo de informação
semântica disponível no próprio código-fonte.
P5. Diagramas e figuras. A documentação deve incluir diagramas e figuras sempre que
possível. No MDD, muitas das informações visuais estão disponíveis na própria linguagem
específica do domínio. Assim, um artefato que serve de entrada para um gerador é o próprio
documento visual do software a ser gerado.
Para a documentação de artefatos de código, pode-se utilizar um formato como o
descrito por Almeida et al. (2008), que contempla cinco seções e seus campos relacionados:
informações básicas, contendo descrições gerais sobre o componente, como seu nome,
propósito e palavras-chave; descrição detalhada, contendo a definição das interfaces
e informações sobre a linguagem de implementação, versionamento, etc; informações
de qualidade, descrevendo as informações necessárias para a garantia de qualidade do