System and Method for JavaDoc separation and maintenance in source code
Original Publication Date: 2002-Sep-25
Included in the Prior Art Database: 2003-Jun-21
Disclosed is a software system, in the area of JavaDoc Documentation development, to manage the JavaDoc documentation, in the Java source code, such that a separate editorial team can edit, proof, and review the documentation. The problem is that as Java software is developed, the software programmer creates and modifies the JavaDoc tags in the Java source code, and these tags are used to create JavaDoc documentation. However, the documentation is best done by a separate development team of editors to ensure that the text is understandable and follows all of the appropriate conventions. This maintenance by a separate team, who is not software programmers, is difficult since the information is commingled with the software. The solution is to provide a development tool to separate the information during specific periods of development, so that it may be edited, proofed, spell checked, and other wise fixed by the editors. Also, the separation of the documentation can be useful in translation. The approach is to design a tool that can scan a Java source tree, and locate all the JavaDoc tags, and produce a flat text source file that contains all the JavaDoc tag information, and on each block of JavaDoc documentation assign a unique @@comment-version version number, and the version number would be placed in the source code as well as the extracted JavaDoc flat text. The JavaDoc comments could optionally be left in the source code in order to make production of a JavaDoc document easier while the editing step is being completed.