Welcome to OpenDEN
Custom Search
Help, Documentation tools
Software Documentation is an important part of software engineering that isoften overlooked. Types of documentation include: * Architecture - Architectural overview of software; including relations to an environment, construction principles to be used in design and technical documentation, etc. * Design - The design of software components.* Technical - Documentation of code, algorithms, interfaces, APIs.* End User - Manuals for the end-user.* Operator - Manuals for the systems administrator.
From : en.wikipedia.org/wiki/Software_Documentation
DelphiDoc
DelphiDoc is a program for automatic generation of documentation on a Delphi-Project. It is created with Javadoc in the mind, i.e. what Javadoc does for Java DelphiDoc should do for Delphi but better fitting to it.
So the documentation is not limited to the HTML format, because in Delphi and Windows the Windows Help format and the new HTML Help are more common, and Windows Help files can be integrated in Delphi's IDE for easy accessibility. As the special character in the comments the tilde "~" has been chosen instead of at "@", because the at-symbol is used in the Pascal language, the tilde is not. But this character can also be redefined to any other. At the moment the documentation can be generated in the HTML (HyperText Markup Language) format, in the Windows help (.hlp-files) format and the new HTML Help format, in the LATEX format or in PDF (Portable Document Format by Adobe) with some additional xfig-/wmf-files. Export to XMI to be used in UML-modelling tools is also possible, and last but not least it is also possible to generate diagrams (UML-like) of the parsed classes etc. and even to include them directly in the documentation.
DelphiDoc's distinctive features are an extensive parsing of the source code and a division of the parser and the generator of the documentation, and there are also a lot of options to tweak the generation. The first means a lot of information is gathered and can be inserted in the documentation making it valuable even if there are no comments (really useful to get acquainted with unknown projects if the generated help file is integrated in that of Delphi). Very much links are inserted as a cross-reference leading from identifiers to other identifiers if they use each other.
The second leads to exchangeable generators for documentation. At the moment five generators can be chosen to create the documentation in the above mentioned formats. Some additional generators for special things are also available. The several options of the generators and "inline command"s inside the documentation make these even more powerful.
So the documentation is not limited to the HTML format, because in Delphi and Windows the Windows Help format and the new HTML Help are more common, and Windows Help files can be integrated in Delphi's IDE for easy accessibility. As the special character in the comments the tilde "~" has been chosen instead of at "@", because the at-symbol is used in the Pascal language, the tilde is not. But this character can also be redefined to any other. At the moment the documentation can be generated in the HTML (HyperText Markup Language) format, in the Windows help (.hlp-files) format and the new HTML Help format, in the LATEX format or in PDF (Portable Document Format by Adobe) with some additional xfig-/wmf-files. Export to XMI to be used in UML-modelling tools is also possible, and last but not least it is also possible to generate diagrams (UML-like) of the parsed classes etc. and even to include them directly in the documentation.
DelphiDoc's distinctive features are an extensive parsing of the source code and a division of the parser and the generator of the documentation, and there are also a lot of options to tweak the generation. The first means a lot of information is gathered and can be inserted in the documentation making it valuable even if there are no comments (really useful to get acquainted with unknown projects if the generated help file is integrated in that of Delphi). Very much links are inserted as a cross-reference leading from identifiers to other identifiers if they use each other.
The second leads to exchangeable generators for documentation. At the moment five generators can be chosen to create the documentation in the above mentioned formats. Some additional generators for special things are also available. The several options of the generators and "inline command"s inside the documentation make these even more powerful.
Loading .....
Recently Viewed Categories
Recently Viewed Products
