Loading...
Publication
Environment analysis: ferramentas de geração de documentação a partir de um sistema SAP
| Name: | Description: | Size: | Format: | |
|---|---|---|---|---|
| 5.8 MB | Adobe PDF |
Authors
Advisor(s)
Abstract(s)
Com o crescimento dos projetos de software, em tamanho, a importância da
documentação do código fonte tornou-se por demais evidente. Todavia, esta
atividade por diversos fatores, como o cumprimento de prazos de entrega e o
tempo gasto com o desviar da atenção dos programadores, vai sendo descurada,
daí que a procura de ferramentas para tornarem este processo autónomo seja da
maior relevância.
Efetivamente, um sistema bem documentado, será de fácil interpretação para
qualquer um, tanto para aquele que entra em contacto pela primeira vez com o
sistema, como para aquele que terá de realizar a sua manutenção.
A documentação de projetos de software é bastante abrangente pois inclui
documentos referentes a requisitos, arquitetura, design, código fonte do
software, testes, manutenção, e todos estes com informação essencial. Para este
trabalho iremos nos focar apenas nas ferramentas para gerar documentação a
partir do código fonte.
Este trabalho propõe-se a criar uma ferramenta de geração de documentação a
partir de um sistema SAPi
, em linguagem de programação ABAPii
, de forma a
que se consiga produzir com pouco esforço documentação com qualidade,
autonomamente.
Na solução apresentada foi implementado estruturas de suporte para a recolha
da informação desejada, seguindo o paradigma da SAP e da linguagem ABAP.
Para posteriormente, produzir a documentação, foi utilizado o Word, ferramenta
de processamento de texto, tendo sido alcançados resultados bastante
interessantes e aplicáveis. Assim, como resultado final obtivemos um documento
Word com conteúdo pré-definido, pelo próprio utilizador da nossa ferramenta,
discriminando todos os artefactos utilizados num dado programa tornando
assim o código fonte mais percetível.
With the growth of software projects, in size, the importance of source code has become all too evident. However, this activity due to several factors, such as meeting delivery deadlines and the time spent deviating the programmers' attention, is being neglected, which is why the search for tools to make this process autonomous is great. In fact, a well-documented system will be easy to interpret for anyone, both for those who come into contact with the system for the first time and for those who must carry out its maintenance. The software design documents is quite comprehensive as it includes documents related to requirements, architecture, design, software source code, tests, maintenance, and all these with essential information. For this work, we will focus only on the tools to generate documents from source code. This work proposes to create a document generation tool from an SAP system, in ABAP programming language, so that it is possible to produce with little effort with quality, independently. In the solution presented, support structures were implemented to obtain the desired information, following the paradigm of SAP and the ABAP language. To study and produce documents, Word, a word processing tool, was used, and very applicable and applicable results were achieved. Thus, as a final result we obtained a Word document with pre-defined content, by the user of our tool, discriminating all the artifacts used in a given program, thus making the source code more noticeable.
With the growth of software projects, in size, the importance of source code has become all too evident. However, this activity due to several factors, such as meeting delivery deadlines and the time spent deviating the programmers' attention, is being neglected, which is why the search for tools to make this process autonomous is great. In fact, a well-documented system will be easy to interpret for anyone, both for those who come into contact with the system for the first time and for those who must carry out its maintenance. The software design documents is quite comprehensive as it includes documents related to requirements, architecture, design, software source code, tests, maintenance, and all these with essential information. For this work, we will focus only on the tools to generate documents from source code. This work proposes to create a document generation tool from an SAP system, in ABAP programming language, so that it is possible to produce with little effort with quality, independently. In the solution presented, support structures were implemented to obtain the desired information, following the paradigm of SAP and the ABAP language. To study and produce documents, Word, a word processing tool, was used, and very applicable and applicable results were achieved. Thus, as a final result we obtained a Word document with pre-defined content, by the user of our tool, discriminating all the artifacts used in a given program, thus making the source code more noticeable.
Description
Keywords
Documentação software Código fonte ABAP SAP Software documentation Source code OLE2Object Engenharia Informática . Faculdade de Ciências Exatas e da Engenharia