Set and use of Doxygen under VS.NET

xiaoxiao2021-03-06  99

The installation file under Doxygen's Windows platform is about 5m or so, you can download below the following address.

download link:

http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

After downloading, you can use the command line method or wizard to generate an comment document.

-------------------------------------------------- -------------------------------------------------- -----------

VS.NET collection: (can refer to CodeProject article 10 minutes to Document your code)

Add external tools to "Generate Documents" under the vs.net "Tool" menu, the parameters are as follows:

Command: c: / program files / doxygen / bin / doxygen.exe (ie DOXYGEN installation directory)

Command parameters: $ (ProjectDir) /Default.doxygen

Initial directory: $ (Projectdir)

Select "Use Output Window" to display the output of Doxygen in the output window of VS.NET.

At the same time, copy Default.doxygen to work in the project directory ($ (Projectdir)).

Open modifications as needed.

Use the previous "Generate Document" tool to generate an HTML type document annotation, and generate the project file of the .hp type HTML Help document.

At the same time installation HTML Help Workshop, you can add a new project to the external tool, call the main execution file, parameters of HTML Help Workshop

Incoming the generated * .hp file, you can directly call the compiled CHM's annotation file.

Add external tools, use the HH.exe command under the Windows directory to start browse the CHM file, so you can do not leave the VS.NET development environment to complete the document.

Generate and view.

In addition:

1.Doxygen does not support the Solution concept in VS.NET, which requires copying Default.doxygen to the specific project directory.

2. The macro definition $ (Projectdir) in VS.NET has a problem, directly transmitting the parameters of HTML Help Workshop multiple quotes, can be manually deleted.

3. I have some common macro in line with Doxygen's annotation style:

SUB function comment ()

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "//!"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ *!"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.seection.indent ()

DTE.ActiveDocument.selection.text = "/ param"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ param"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ return"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ sa"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "* /" DTE.ActiveDocument.selection.startofline (vSstartoflineOptions.vsstartoflineOptionsfirstText)

DTE.ActiveDocument.selection.deleteleft ()

End Sub

SUB variable comment ()

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "//!"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.startofline (vSstartoflineOptions.vsstartoflineOptionsfirsttext)

DTE.ActiveDocument.selection.deleteleft ()

End Sub

SUB file comment ()

DTE.ActiveDocument.selection.text = "/ ** / file" DTE.ActiveDocument.name "copyright (C) 2000-2004, my company

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.seection.indent ()

DTE.ActiveDocument.selection.text = "/ n file name:" DTE.ActiveDocument.name

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ n function description:"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ author my big name"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ n Historical Information: First Edition" Date.Now

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.deleteleft ()

DTE.ActiveDocument.Selection.Text = "* /"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.startofline (vSstartoflineOptions.vsstartoflineOptionsfirsttext)

End Sub

SUB variable detailed note ()

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "//!"

DTE.ActiveDocument.selection.newline ()

DTE.ActiveDocument.selection.text = "/ *!"

DTE.ActiveDocument.selection.newline () DTE.ActiveDocument.selection.indent ()

DTE.ActiveDocument.Selection.Text = "* /"

DTE.ActiveDocument.selection.startofline (vSstartoflineOptions.vsstartoflineOptionsfirsttext)

DTE.ActiveDocument.selection.deleteleft ()

End Sub

转载请注明原文地址:https://www.9cbs.com/read-105629.html

New Post(0)