Eclipse C + + annotation templates and annotation document generation

The first comment is that you can use Chinese, the main purpose is to make others understand.

Annotations can be regulated through the Eclipse template settings: Windows---preferences---c + +----Code Style----codetemplates. Here's how to set a shortcut key to automatically enter a template during write code:

First set up related template input, windows-preferences-c/c++-editor-templates, add custom 2 templates, zsdata (data type definition annotation template), Zsfunc (function annotation template).

Zsdata is set as follows:

/** briefly ${cursor} * * Detailed description */

Zsfunc is set as follows:

/** briefly ${cursor} * * Here to write detailed information about the function * @param [in] (input parameter description, including the function of each parameter, values and the relationship between parameters) * @param [out] (description of output parameters) * @return (description of return value) * @see (This function refers to other related functions, here is a link) * @note (description of issues to be noted) */

Next set shortcut key: Windows-preferences-general-keys:

The shortcut key for setting up C/c++content Assist (Templates proposals) is alt+z. Another important shortcut is word completion, the original shortcut is alt+/, can be set to alt+x and other more convenient way.

Doxygen is a code documentation tool.

Download Address: www.doxygen.org

Graphviz

This tool is used with Doxygen, can extract functions, the call between modules is close, very clear. Download Address: http://www.graphviz.org/

With the Doxygen tool, the Help document is automatically generated by configuring settings such as the project source file path, and the integration Graphviz can have a file relationship diagram. If necessary, the generated HTML is also generated with the HTML Help Workshop CHM, which is not described here.