Doxygen code Comment specifications and production documentation

Doxygen is a program documentation generation tool that converts feature annotations in a program to a description file. Installation and initialization

Please download the latest version of Doxygen on the http://www.stack.nl/~dimitri/doxygen/doxygen_usage.html. Download for Windows 95/98/ME/NT/2000/XP Setup version, just give the correct installation directory, step-by-step installation complete.

Doxygen produces documents in three steps: A.   Create a project file for Project B.   Add the annotation format in the program code that conforms to the Doxygen definition; Use Doxygen to generate documents;

Create a Doxygen project status file for your project, a project status file that is actually set for key and value.

Through the Doxywizard inside the wizard can create a new project status file, set the project name, project version number, source code stored in the directory, build the document directory.

Note: The path name must be all English text, otherwise can not identify.

Through the doxywizard inside the expert can be set on the state file key, the following is a common set of flags:

Project_Name	The name of Project, with a single word, multiple words, enclose in double quotes
Project_version	Version number of Project
Output_directory	The output path. The resulting file will be placed under this path. If this path is not filled, the path will be the output path as it is currently located.
Output_language	The output language. After the english,1.2.16 version is available, you can use Chinese to export the Chinese format.
INPUT	Specifies the path to load or find the program code directory to process. This is a form of table-column. And you can specify the document and path. For example, you have A.C, B.C, c.c three documents. You can use the input = A.C, B.C, C.C way. If you give a directory, all documents below the directory will be processed.
File_patterns	If the directory is specified in your input Tag. You can use this tag to ask Doxygen to act on a specific document when processing it. For example, you want to work with documents with the. C,. cpp, and. h extensions under the directory. You can set file_patterns = *.c, *.cpp, *.h.
Recursive	This is a bool tag that only accepts yes or No. When set to Yes, all subdirectories of the directory specified in input are processed.
EXCLUDE	If you have a certain number of specific documents or directories, do not want to go through doxygen processing. You can specify in this tag.
Exclude_patterns	Similar to the usage of file_patterns, only this tag is used by exclude.
Source_browser	If set to Yes, Doxygen will produce a list of the original files.
Inline_sources	If set to Yes, the program code is also embedded in the description file.
Alphabetical_index	If set to Yes, an alphabetical list is added to the resulting file.
Generate_html	If set to Yes, an HTML version of the stated file will be generated. An HTML file is one of the formats that Doxygen presets produce.
Html_output	The output directory of the HTML file. This is a relative path, so the actual path is Output_directory plus html_output. This setting is preset to HTML.
Html_file_extension	The extension name of the HTML file. Preset to. html.
Html_header	The header to use in the HTML file for each page. If not specified, Doxygen uses its own preset header.
Html_footer	To use the footer in each page of the HTML file. If not specified, Doxygen uses its own preset footer.
Html_stylesheet	You can set a CSS to make the output of HTML more perfect.
Generate_htmlhelp	If set to Yes,doxygen, an index file will be generated. This index file is used when you need to make a Help file in HTML format on Windows.
Generate_treeview	If set to Yes,doxygen will help you create a tree structure, on the left side of the screen.
Treeview_width	Use to set the width of the tree structure on the screen.
Generate_latex	When set to Yes, a latex file is generated. However, your system will require the installation of Latex related tools.
Latex_output	The output directory of the Latex file, the same as the Html_output usage, refers to the path below the output_directory. The preset is latex.
Generate_rtf	If it is set to Yes, it will produce the rich Text format of the stated file.
Rtf_output	Same as Html_output usage, to specify the RTF output file path. The preset is RTF.
Generate_man	If set to Yes, the UNIX man Page format will produce the stated file.
Man_output	Same as Html_output usage, specify the output directory for the man page. A man is predicted.
Generate_xml	If it is set to Yes, it will produce an XML-formatted stated file.
Enable_preprocessing	If set to Yes, Doxygen will start C's front processor to process the original file.

Save the project status and start building the document.

write the correct format of the comment header file Head Note specification, note must list the copyright description, version number, date of generation, author, content, function, relationship with other files, modify the log, etc., in the header file comments should also function briefly:///////////////// ////////////////////////////////////////////////////////////////

Copyright (C), 2005-2007.

/file WindowsNT

/brief Windows Nice Try.

/author Bill Gates

In a cave and grooving with a PICT.

//