SOEN6441.5.apidocgen-converted.pdf - SOEN 6441 Advanced...

This preview shows page 1 - 6 out of 24 pages.

Concordia University Department of Computer Science and Software Engineering ADVANCED PROGRAMING PRACTICES API documentation generation tools Javadoc Joey Paquet, 2006-2021 1 SOEN 6441 - Advanced Programming Practices
Concordia University Department of Computer Science and Software Engineering Historically, manual documentation generation was used to write API documentation to help developers to understand how to use libraries or modules. Good API documentation is necessary for libraries to be widely accepted and used correctly and efficiently. Manual documentation has many disadvantages: Very time-consuming to write. Error-prone. Requires dedication and time to update. Outdated or wrong API documentation may be worse than having none. API documentation generation tools Joey Paquet, 2006-2021 2 SOEN 6441 - Advanced Programming Practices
Concordia University Department of Computer Science and Software Engineering The goal of having API documentation is to make the software more understandable , decreasing the amount of time the programmers spend in learning how to use libraries/modules/classes. To be really useful and economically viable , the time to write/maintain API documentation must be less than the time it allows to save by its use. API documentation became much more useful with the advent of hypertext and automation tools . Hypertext enables very efficient browsing through huge documentation. Automated tools can be used to extract API documentation from code. Lowers the cost of writing/maintaining API documentation though automation . Many such tools now exist, e.g. Javadoc and Doxygen. All of them can generate hypertext documents. API documentation generation tools Joey Paquet, 2006-2021 3 SOEN 6441 - Advanced Programming Practices
Concordia University Department of Computer Science and Software Engineering Javadoc Joey Paquet, 2006-2021 4 SOEN 6441 - Advanced Programming Practices
Concordia University Department of Computer Science and Software Engineering JavaDoc is a software tool part of Java SDK for generating API documentation from Java source code augmented with special tags in the code s comments. Javadoc is an industry standard for documenting Java classes. How does JavaDoc work? Instead of writing and maintaining separate documentation, the programmer writes specially-formatted comments in the Java code itself. The JavaDoc tool is a compiler that reads these comments and generates an API documentation out of them. It also gets information from the code itself, then merges both of these information sources together to create a structured, hyperlink-browsable document.

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture

  • Left Quote Icon

    Student Picture