On February 1, 2005, the weapon of the development document was prepared in these two days. My colleague "Li Shu" introduced a good tool for writing code documents. This software is an open source project. Although the interface is difficult to see, it is still quite Practical tools. With this tool, it can be very convenient to generate a program development document, no matter from the layout or from the organization, it can be said to be first-class, I spent an hour, I have studied it is really good. (1) Basic settings First, then install it from the next Doxygen tool and install it on your machine, then try not to change the tool settings, just modify a few places, you can open the Wizard dialog and click the Expert button under the Projectd page. Do the following settings You will find that the write program document is still more cool: full_path_names selection: javadoc_autobriEf Select this option After you can generate a document in the format of the Java document, the first sentence is a brief description, I prefer this style, it Most of the examples are the documentation in the QT format, which is not beautiful, so it is recommended not to use. Click on the build page No: show_directories Unless you want to display your code path name and file name (2) Comment style huh, you said that the comment style is, because I have written in accordance with the Java documentation, so the change is not very big. The main style is as follows / ** iChart iChart.h "inc / ichart.h". * This is base Abstract Class for Chart * * iChart Is Abstract Class for All Type of Chart * / Main code style is like Java The code comment style is the annotation style of class C. The next sentence of "/ **" is generally considered to be a brief description, remember to add a symbol of the end of the brief description. "Otherwise Will be considered a line. Name / ** * Initialize the chart. * @Param char * Title - [in] chart title name * @Param char * category - [in] chart category name * @Param Char * value - [in] chart Value name * @Param iDataSet * Data - [in] chart data * @Param Bool Brow - [In, Default] Use row data or use column data * / virtual void; init (char * title, char * category, char * value , Idataset * Data, Icolors * Colors, Bool Brow = true) = 0 / ** * The Chart Color Table Used to Display Chart Plot. * @Param IColors * Colors - [in] The color table * @return a character Pointer .. * / Virtual void set_colortable (ICOLORS * Colors) = 0; Here is the other part to say that there are several keyword "@Param" to indicate the parameters, and the keyword can be generated in the document. The document of the parameter is also a keyword "@return" this is the return value keyword. It has this document that can generate the returned value. As long as there are these few basic, it can generate a better look. The program documentation, the code is written, it is really a good stuff. It is highly recommended that everyone uses this tool to generate project documents.
Other keywords are waiting for it ... (3) The generated document example main page |
Class hierarchy |
Class List |
Class MEMBERS
Ichart Class Referenceichart
Ichart.h "inc / ichart.h" this is base abstract class for char.
More ...
#include
List of all members.
Public Member Functionsvirtual IColors * get_colortable () = 0 the chart color table used to display chart plot. Virtual void set_colortable (IColors * colors) = 0 the chart color table used to display chart plot. Virtual char * get_title () = 0 the chart Title Property Virtual Void Init (Char * Title, Char * Category, Char * Value, iDataSet * Data, Icolors * Colors, Bool Brow = true) = 0 Initialize the Chart.
Detailed Description iChart
Ichart.h "inc / ichart.h" this is base abstract class for char.
Ichart Is Abstract Class for All Type of Chart
MEMBER FUNCTION Documentation
Virtual iColors * iChart :: get_colortable () [Pure Virtual]
The Chart Color Table Used To Display Chart Plot. Return a Character Pointer.
Virtual Void iChart :: Init (Char * Title, Char * Category, Char * Value, Idataset * Data, Icolors * Colors, Bool Brow = true) [Pure Virtual]
Initialize the chart.
Parameters:
Char * title - [in] chart title name char * category - [in] chart category name char * value - [in] chart value name idataset * data - [in] Chart Data Bool Bool Brow - [in, default] Use row data OR USE Column Data
Virtual void iChart :: set_colortable (iColors * colors) [Pure Virtual]
The Chart Color Table Used to Display Chart Plot.
Parameters:
Icolors * Colors - [in] The color TABLE
Returns:
A Character Pointer.
The Documentation for this Class Was Generated from the FOLLOWING FILE:
IChart.h
Generated on tue feb 1 16:18:45 2005 for chart by 1.4.1
