Hi, I just again to all. Now in this entry we'll talk a little about the documentation of a software project, its importance and some ways of how to do it.
Why do we want to document a project? o What is its significance?
The reason this question is that, in documenting a project, program or programming practices help us much when it can be reused, reuse Why?, If we d masters 
account in the programming uses many codes that we had used, for example, when we began to teach programming algorithms and then we saw some occasions we programmed them to understand their operation and have a vague idea of \u200b\u200bhow we would or we could use, so we put comments so that we will not forget any detail or to or was a function. Once we are advancing and developing software we realize that they are very useful, because we are saving steps and help make things simpler, so I used this code, or if we had developed a program, it would only be necessary see the comments and take part relevant or useful, without taking the trouble read the entire code. Apart
account in the programming uses many codes that we had used, for example, when we began to teach programming algorithms and then we saw some occasions we programmed them to understand their operation and have a vague idea of \u200b\u200bhow we would or we could use, so we put comments so that we will not forget any detail or to or was a function. Once we are advancing and developing software we realize that they are very useful, because we are saving steps and help make things simpler, so I used this code, or if we had developed a program, it would only be necessary see the comments and take part relevant or useful, without taking the trouble read the entire code. Apart that documentation helps us when we give the client software or 
share our code it know how it works, its installation, the technical guide and more.
pallabras In short, the documentation is a set of information that gives details of software developed or being developed, as would be the work of it, knowing the process, structure and / or on occasion to know where it could be a program error.
share our code it know how it works, its installation, the technical guide and more. pallabras In short, the documentation is a set of information that gives details of software developed or being developed, as would be the work of it, knowing the process, structure and / or on occasion to know where it could be a program error.
How can we document a code of a program? There
many ways very useful and helpful, allowing us to document the program code. Like for example if we want to document a Java language program, use the utility javadoc, which, it allows us to generate documents in HTML format and APIs it documents the kinds of program and comments are put into it.
For python there are several utilities, one of them is PythonDoc , which does the same as javadoc, APIs will generate documents in HTML or some other format that is needed, another utility could be Epydoc that does the same that PythonDoc, only that it to you in HTML or PDF documents. Php
For this language as phpDocumentor utility also does exactly the same as the previous earnings.
saying I could go several utilities that can help us to document, as there are several and different languages, it is cuenstión to give a search on google.
It will soon be all, if you have any questions or suggestions, discuss it and will block them out. Greetings
For python there are several utilities, one of them is PythonDoc , which does the same as javadoc, APIs will generate documents in HTML or some other format that is needed, another utility could be Epydoc that does the same that PythonDoc, only that it to you in HTML or PDF documents. Php
For this language as phpDocumentor utility also does exactly the same as the previous earnings.
saying I could go several utilities that can help us to document, as there are several and different languages, it is cuenstión to give a search on google.
It will soon be all, if you have any questions or suggestions, discuss it and will block them out. Greetings
0 comments:
Post a Comment