doxygen?稿?抽??棰?
??涓昏???璁剧疆???
?板??wizard瀵硅??妗?涓?澶т?璁剧疆涓?,?跺??
?export璁剧疆:
?project->DOXYFILE_ENCODING=GBK
?project->OUTPUT_LANGUAGE=chinese?
?input->INPUT_ENCODING=GBK
?Dot->HAVE_DOT
?Dot-> UML_LOOK
?Dot->CALL_GRAPH
?Dot->CALLER_GRAPH?
?
http://www.fmddlmyy.cn/text21.html?
http://blog.csdn.net/fengrx/archive/2009/09/15/4554830.aspx?
涓?杞?oxygen??binary ??
doxygen涓?杞藉?板??
http://www.10.xdowns.com/uploadFile/2007-7/doxygen.rar
涓轰?浣?oxygen?藉?灏?绫诲?俱????浣??剧?????ュ?版??妗ｄ腑锛?杩?瑕?涓?杞藉??瑁?graphviz for win??
graphviz 2.18涓?杞斤?
http://www.graphviz.org/pub/graphviz/ARCHIVE/graphviz-2.18.exe
?ㄩ?ㄥ??瑁???灏卞??浠ュ?濮?浣跨?ㄤ???
杩?琛?doxygen wizard.exe
濡? ??浣?????涓??峰???????杩??惧舰???㈣?琛?doxygen??璇?锛?璇峰??oxygen??bin??褰?涓?杩?琛?doxywizard.exe锛?杩??舵????oxygen????褰?涓?????妗ｏ?doxygen_manual-1.5.2.chm锛?涓? Doxywizard usage涓?????璇存??璁剧疆?冲????涓昏?????锛?婧???璺?寰???宸ヤ?璺?寰???杈??鸿矾寰?绛???
?瑰?濮?锛??冲????????妗?
????瀵规??妗ｇ????杩?绋?涓????扮??涓?浜???棰?杩?琛?璇存??锛?
1 涓?????棰?锛?涓???娉ㄩ???ㄦ??妗ｄ腑??涔辩????
瑙ｅ?筹???xpert涓???INPUT??椤归〉??INPUT_ENCODEING涓?濉??モ??GB2312??锛?杩??峰?轰?GB??????缂?杈??ㄧ??????浠ｇ??灏卞??浠ユ?ｅ父浣跨?ㄤ???
浣???锛?杩???涓?涓???娉?褰诲?瑙ｅ?崇????棰?灏辨??锛?褰?杈??鸿??瑷?涓轰腑???跺乏杈圭??瀵艰??????????涓???浠??舵??涔辩??????浣???瑙ｅ?虫?规?锛?璇峰?″????ワ?
2 ?惧舰??棰?锛???娉?缁??剁被?惧??浣??剧???惧舰??
棣? ??纭?淇?瀹?瑁?浜?graphviz for win锛?娉ㄦ??涓???wingraphviz锛???????涓?涓?graphviz??com灏?瑁?锛?浣???doxygen骞朵????轰?瀹?寮?????锛???浠ヨ?浜?涔?娌＄?ㄣ???跺????expert??DOT_PATH涓?濉???raphviz??瀹?瑁?璺?寰????ョ????izard??diagram涓????╅??瑕????????惧舰绫诲??灏卞??浠ヤ???
濡????虹?版??娉?????.map??浠剁????璇?锛???浠ュ?宸ヤ???褰?璁剧疆??html锛?骞跺?html涓???????浠堕?芥??ゅ??璇???杩?涓???棰???????杩?涓?澶?纭?瀹???
3 杈???hm????棰?锛?濡?浣?杈???chm??浠?/h4>
1. 浣?蹇?椤诲??瑁?寰?杞????剁?稿?煎?圭??chm缂?璇?绯荤?????甯镐负HTML Help Workshop??
2. 棣?????Wizard...]??Output椤甸??腑锛?????TML锛??跺?????╁??repare for compressed HTML(.chm)??
3. ?舵?″??Expert...]??HTML椤甸??腑锛?灏?HHC_LOCATION????寰?杞???hhc宸ュ?枫????甯镐负C:/Program Files/HTML Help Workshop/hhc.exe???跺???瑰??K锛?淇?瀛?锛?缂?璇??冲????
5 濡?浣??绘??CHM??甯???CHI??浠讹?
娉????ㄩ?璁ゆ???典?锛?CHM浼???涓?涓?CHI??浠讹?浼间????ㄦ?ュ????绱㈠?????????浜轰????拌?寰?澶??ㄦ?蜂?浠?涓?浼?浜?CHM锛???娌℃??涓?浼?CHI??浠讹?瀵艰?存??娉?姝ｅ父?剧ず?? ???点????涓??ラ????????浠ラ??杩?宸ュ?烽??寤?HI??浠讹?浣?????瑙?寰??抽??杩?涓????藉?冲??????寮?[Expert...]??HTML椤甸?????娑?GENERATE_CHI ?冲????6 濡?浣???MSDN?ｆ?峰?宠竟姣?椤垫?剧ず涓?涓??芥?帮?
杩?涓???棰??跺??姣?杈?妫???锛???Expert...]涓??? Project椤甸???涓??㈡??涓?涓???椤瑰????SEPARATE_MEMBER_PAGES锛???杩?涓???椤归??涓?锛?杩??锋??涓??芥?板氨??涓?涓?椤点??浣???浼???涓?涓???棰?锛??ｅ氨 ???宠竟椤甸?㈢????杈瑰?浜??????芥?扮????琛ㄣ??寰????撅?缁?杩???绌讹?杩?涓?纭?瀹???娉??绘????????瑙ｅ?虫?规?灏辨????宸辩?璇?涓?涓?doxygen锛???memberlist.cpp??writeDocumentationPage?芥?颁腑灏? container->writeQuickMemberLinks(ol,md);杩?????杩???琛?灞??芥???冲????7 濡?浣???HM涓??绘??褰?????UBGROUPING???绘????缁???缁?淇℃??锛?
杩? 涓????藉氨????hm??宸?竟??涓??存?ュ???哄?芥?板??琛????涓??ㄧ?瑰?荤???宠竟椤甸?????杩?涓????介??瑕?淇??规?浠ｇ??????ndex.cpp涓?锛?灞???writeGroupIndexItem?芥?扮?? Doxygen::indexList.addContentsItem锛?Doxygen::indexList.incContentsDepth?? Doxygen::indexList.decContentsDepth();?冲??锛??蜂?涓?瑙ｉ??浜?锛?涓???渚跨?ャ??8 濡?浣?淇??规?????绘???充???Generated at ...????瀛?锛?
?? 寮?[Expert...]??HTML椤甸????跺????TML_FOOTER涓???瀹??稿???HTML??浠跺?冲????娉ㄦ??HTML_FOOTER涓??冲?????BODY?? HTML缁?????璁般???充?涓???灏???灏鹃??TML?冲???杩???lt;/BODY></HTML>??????锛?濡???浣?瑕???瀹?浜? HTML_HEADER锛?浠??冲?????<HTML><HEAD></HEAD><BODY>9 濡?浣?????缁?锛?
缁? 灏辨????浠ユ????绫荤???芥?版?惧?颁?涓??逛????剧ず?瑰???doxygen????grouping锛??充???浠ユ???稿?崇??浠ｇ????杩???蹇?锛??惧?板??涓?涓?缁?涓?锛?渚夸??ョ????杩?涓昏??? ??杩???涓???缃?璇?娉??戒护??棣?????杩?@defgroup瀹?涔?涓?涓?缁?锛??跺??瑕?????缁????芥?版????绫荤??锛???杩???蹇?@ingroup???ョ?稿???缁???杩??凤??稿????芥?板氨 琚??剧疆?ㄥ??涓?涓?缁?涓???10 濡?浣?????涓???甯??╋?
?瑰??Expert...]锛??ㄩ〉Project ??OUTPUT_LANGUAGE锛?????hinese锛?杩??疯??虹??甯??╂??绀轰俊??灏辨??涓??????蜂?涓?????绀轰俊??????瀛??ㄦ?浠ｇ??涓??? 11 濡?浣?褰诲?瑙ｅ??oxyGen??杈??轰腑??chm??涔辩????棰?锛?
DoxyGen??瀹??颁腑澶ф???涓?澶?缂?????璁剧疆??棣?????锛?doxyfile锛?涔?灏辨????缃???浠躲???舵?★?INPUT_ENCODING锛?涔?灏辨??DoxyGen??瑕?瑙ｆ????杈??ユ??浠剁??缂?????????锛?灏辨??杈??虹??缂?????璀?濡?CHM宸?竟??绱㈠?缂?????
棣? ????chm????棰?涔辩??锛?杩?涓?姣?杈?濂借В?筹???涓?oxyWizard浣跨??T?????????瀹????ㄥ??浜?杞??????浠ュ??oxyWizard涓?杈??ヤ腑??锛??ㄤ?瀛???????锛?浠???宸卞??浜?杞???锛?瀵艰??oxyfile涓?????缁???淇?瀛?淇℃??涓?姝ｇ‘??杩?涓??跺??????瑕??ㄨ?颁?????寮?doxyfile??缃???浠讹?杈??ョ?稿?涓????冲????娉ㄦ??淇?瀛? ???跺??淇?瀛???ANSI缂????冲????淇?瀛????朵??煎???璇????介??瑕??绘??BOM锛?姣?杈?楹荤???娌＄??绌朵???杩?涓??稿???缂???璁剧疆??Expert...]涓?锛?椤?Project ?? DOXYFILE_ENCODING锛?涓?杈??ユ????榛?璁や负UTF-8?借???
?舵?℃???宠竟??瀹逛贡??锛?杩?涓?澶???????涓轰?娌?????缃?濂借??ョ????浠剁???绫诲????????????Expert...]??Input椤甸??腑锛???涓?涓?INPUT_ENCODING锛?杩?涓???椤硅〃绀鸿??ユ??浠剁??缂?????寮?锛?杩?瑕???浣?澶?????婧???浠舵?煎?涓??淬??瀵逛???浠??ヨ?达?浣跨??s??浜猴?锛?涓???璁剧疆涓?B2312??褰??讹???娆″０??锛?缂????瑰????充?婧???浠剁??缂????瑰???濡?????浠?缂???宸茬???UTF-8浜?锛??惰??浣?杩?灏??惰?剧疆??GB2312锛??ｄ?DoxyGen浼?灏?UTF-8褰???ANSI??杩?琛?涓?娆?TF-8杞???????朵??洪??浜???
?? ??涔???缁?甯搁???扮????棰?灏辨??DoxyGen??????CHM??浠剁??宸?竟????褰???涓???????浜?涔辩????杩?涓?????瑕?灏?chm绱㈠???缂???绫诲??淇??逛负GB2312?冲??????HTML??CHM_INDEX_ENCODING涓?杈???B2312?冲?????惰??杩?绉??规?涓?锛?杩???涓?涓????典?澶?锛?灏辨??chm????绱㈤〉????绱㈢???涓??剧ず??涓??? ??瀛??村????涔辩??浜???杩?????涓?oxyGen榛?璁ゅ???浜?HTML Help Workshop??Full-text search?ㄦ????绱㈤??椤癸?浠??ㄨ?琛??ㄦ????绱㈢???跺??锛?搴?璇ユ????寮???浠剁?跺??????NSI杩?琛???绱㈢??锛?锛?璧???琛ㄧずHHW涓?????UTF-8锛?浠?????ISO- 8859-1????windows-1252缂?????锛???Doxygen???????宠竟???㈢?涓???UTF-8锛?杩????跺?虹?颁???棰??????ㄨ?绉????典????ㄦ????绱????璁?涓????芥??绱㈣?辨????
??濂?锛???浠???瑙ｅ?虫?规????芥?????扮?璇?DoxyGen浠ｇ??锛?涓轰?婊¤冻??绱????瑕?淇?璇??宠竟??椤甸?㈡??浠朵???UTF-8?冲???? ??浠?棣???淇???riteDefaultHeaderFile杩?涓??芥?扮??浠ｇ??锛?灏???harset=GB2312???跺????TranslatorDecoder???????芥?颁腑淇???_toUtf8 = (void*)-1;?冲??芥???????ユ?舵??缁???杞??㈠?芥?般??????????NPUT_ENCODING??璁剧疆????杈???TF-8??杩??蜂?浣?oxyGen璁や负??浠? ????????UTF-8??锛?浠???涓??ㄨ?琛?杞??????????挎?㈠??濮???DoxyGen?冲????
?????瑕?琛ュ??????锛?杩???涓?绉??规???涓??ㄤ慨?逛?????婧?浠ｇ??锛?浣?????瑕?灏?DoxyGen???????宠竟??HTML??浠朵娇?ㄥ伐?凤?濡?iconv锛???宸ヨ浆?㈡??GB2312锛??跺????浣跨??TML Help Workshop????锛?缃?涓???绡???绔?浠?缁?杩?锛???娴?璇?涓?涓?锛?涔???娌℃????棰?????
????锛?doxygen??涓?涓?寮?婧?椤圭??锛?骞朵?????vs2005椤圭??锛?杩??蜂??ワ?濡???浣?瑙?寰?????涓?椤烘??锛?瀹??ㄥ??浠ユ??浠ｇ??涓?杞藉????琛?缂?璇????界?舵????瑙?doxygen??浠ｇ??????涓??界????perfect锛?浣???瀵逛?涓?涓?杩??风??宸ョ?锛???浠???璁哄?浣??介??瑕?涓?绉???????绁?濂借?~
杩??凤??烘??涓?灏辫?藉???oxygen????婕?浜?????妗ｄ???浠ｇ???归???doxygen????澶?绉??煎???娉ㄩ??椋??硷??规??manual???╄??宸卞??娆㈢??灏卞ソ??
?稿?冲????锛?
http://blog.csdn.net/sfcyyc/archive/2008/07/15/2653683.aspx
DOXYGEN绠???瀹??ㄦ??绋?
浠ｇ????澶?浜??惧????瑕?????妗ｏ?缁???宸辫???缁???浜虹???介??瑕?濡?姝わ?杩?娆?BOX360?朵?锛?????娌℃??涔???娉ㄩ??锛???澶存??ug?借?????澶╄??宸卞????浠ｇ????浠?涔????????村??????浜哄????涓?瑗匡?100琛?浠ｇ??涔?娌℃??涓??ユ敞??锛?骞稿ソ涓?????缁存?わ?????瑕?????浜???
?变?涓?澶╁??澶?灏?璇?浜?涓?涓?Doxygen??浣跨???杩?濂戒??撅?浣?????浜?纾?纾?缁?缁?锛?瀹???宸辩????妗ｄ?璇翠?娓?妤?锛?缃?涓????烘?ョ????绋?涔?????缁??烘?峰??锛????扮????棰?杩???????宸卞?璇?浜?????娆℃????瀹???
涓?绠″?浣?锛?甯哥?ㄧ??涓?瑗块?藉??浠ュ??烘?ヤ???璐村?ㄤ????
?-----------------------------------------------------------------------------------
1.????娉ㄩ???藉??浠ヤ娇??//寮?濮?(C++椋?????
2.绫讳???蹇?椤诲??涓?///??杩帮?????浼?浜х??璀?????Compound 绫诲?? is not documented??
? ??杩颁腑??濂戒?瑕?甯???姝ょ被??绫诲??锛?????浼?浜х??涓や釜?炬??浣???????涓?涓???浠?褰卞??缇?瑙???
3.public??protected浼????ㄧ????锛?浣???private瑕???xpert??Build??椤归???句腑EXTRACT_PRIVATE锛?static????涔???濡?姝ゃ??
4.?芥?版敞???瑰?
?? ?/// Constructor???芥?版??杩般??
?? ?/// @param [in] pos?? ??? The position of Camera in world coordinate?? ????? ?????版??杩???
?? ?/// @param [in] lookat??? The point Camera looks at in world coordinate?? ??????版??杩???
?? ?BaseCamera( const D3DXVECTOR3& pos, const D3DXVECTOR3& lookat );
5.????娉ㄩ???瑰?
?? ?D3DXVECTOR3 m_Position;?? ??? ??
?? ?D3DXVECTOR3 m_Position;?? ?///< Camera position point in world coordinate
涓ょ??瑰?浜х????缁???涓?????????浼?????浜х??涓???Member Data Documentation娉ㄩ??锛?????浼???ubilc/Protected/Private Attributes??????杩板??绱ц?娉ㄩ????
6.@???板??\???扮?稿??
7.浜х????杩伴『搴???娉ㄩ??椤哄??稿??锛?涓???椋??间负
?? ?/// ?芥?版??杩? ?? ?/// @param ?? ????版??杩? ?? ?/// @return ?? ?杩????兼??杩? ?? ?/// @retval ?? ?杩????? ?? ?杩???????杩? ?? ?/// @retval ?? ?杩????? ?? ?杩???????杩? ?? ?/// @remarks ?? ?娉ㄦ??浜?椤? ?? ?/// @note?? ?娉ㄦ??浜?椤癸????藉??@remarks,?剧ず瀛??蜂???
?? ?/// @par?? ???瀹?涔??惧??锛????㈠??璺?绀轰?浠ｇ??涔?绫? ?? ?/// @code(蹇?椤讳娇??endcode缁???)
?? ?/// 绀轰?浠ｇ??(????缂╄?)?? ?
?? ?/// @endcode
?? ?/// @see ?? ??朵?????椤广??浜х?????????????炬?ャ??
?? ??芥?颁唬??澹版??
8.?规??绗??? ?? ?/// -?? ??? ?浜х??涓?涓?榛??插????
9.瀹?涔??ㄧ被浣????㈢??enum
?? ?/// Camera types
?? ?enum CAMERA_TYPE
?? ?{
?? ??? ?CAMERA_FIRST_VIEW,
?? ??? ?CAMERA_MODEL_VIEW,///< Camera that looks from the third view
?? ?};
?? ?涓ょ?椋??肩?稿????
浠ヤ?寮?濮???椤归?芥???ㄥ???绫诲??瀹?涔?锛??ㄦ??浠舵??寮?濮?(??灏?璇?????nclude涔???) 蹇?椤诲??涓???/// \file ??浠跺????锛?????涓?浼?????娉ㄩ????娌℃??File Member椤点????
10. 瀹?涔??ㄦ??浠堕???㈢??瀹?
??? ?#define CAMERA_TYPE_NUMBER???? ///< The number of camera types.?? ??? ??
?? ? #define CAMERA_TYPE_NUMBER????
椋??艰?存??瑙?5??
11. ??绫诲??enum瀹?涔???10.?? ??? ?涓ょ?椋??肩?稿????瑙?9??
12. ??绫诲??typedef瀹?涔???10. ?? ?椋??艰?存??瑙?5??
-----------------------------------------------------------
Doxygen
??涓轰唬????澶э???浜?涓?瑗垮???㈠?????㈠?锛???瑕?涓?浜?娉ㄩ??锛???涓?瑙???????缁?????娉ㄩ??璧蜂?浜?澶т??????姝ら???ㄩ?榧?澶у????doxygen.
1.setup ?存?ラ????p ?? binary????涓烘???惰?娌℃???跺????瑕?锛???浠ユ病??涓?杞借?ュ共杈??╄蒋浠躲??
2.documenting the code
?? 娉ㄩ??琚???涓轰?绫? brief description and detailed description for code item, and in body description.
Detailed descripting way:
1.
2.
3
///(!)
///(!)
///(!)
Some people like to make their comment blocks more visible in the documentation. For this purpose you can use the following:
/********************************************//**
* ... text
***********************************************/
(note the 2 slashes to end the normal comment block and start a special comment block).
or
/
/// ... text ...
/ ?
Brief descripting:
-
One could use the?\brief?command with one of the above comment blocks. This command ends at the end of a paragraph, so the detailed description follows after an empty line.
Here is an example:
/*! \brief Brief description. * Brief description continued. * * Detailed description starts here. */ - If?JAVADOC_AUTOBRIEF?is set to?
YES
The option has the same effect for multi-line special C++ comments:/** Brief description which ends at this dot. Details follow * here. *//// Brief description which ends at this dot. Details follow /// here. - A third option is to use a special C++ style comment which does not span more than one line. Here are two examples:
or/// Brief description. /** Detailed description. *///! Brief description. //! Detailed description //! starts here.
? ? //! A test class.
/*!
A more elaborate class description.
*/
class Test
{
public:
//! An enum.
/*! More detailed enum description. */
enum TEnum {
TVal1, /*!< Enum value TVal1. */
TVal2, /*!< Enum value TVal2. */
TVal3 /*!< Enum value TVal3. */
}
//! Enum pointer.
/*! Details. */
*enumPtr,
//! Enum variable.
/*! Details. */
enumVar;
//! A constructor.
/*!
A more elaborate description of the constructor.
*/
Test();
//! A destructor.
/*!
A more elaborate description of the destructor.
*/
~Test();
//! A normal member taking two arguments and returning an integer value.
/*!
\param a an integer argument.
\param s a constant character pointer.
\return The test results
\sa Test(), ~Test(), testMeToo() and publicVar()
*/
int testMe(int a,const char *s);
//! A pure virtual member.
/*!
\sa testMe()
\param c1 the first argument.
\param c2 the second argument.
*/
virtual void testMeToo(char c1,char c2) = 0;
//! A public variable.
/*!
Details.
*/
int publicVar;
//! A function variable.
/*!
Details.
*/
int (*handler)(int a,int b);
} ?
瑙?寰?杩?涓?渚?瀛?涓???娉ㄩ???瑰?涓???锛?涓??ㄦ?插お澶?娆￠????锛??冲?????ㄨ?绉???
?
Putting documentation after members
If you want to document the members of a file, struct, union, class, or enum, and you want to put the documentation for these members inside the compound, it is sometimes desired to place the documentation block after the member instead of before. For this purpose you have to put an additional < marker in the comment block. Note that this also works for the parameters of a function.
?
Documentation at other places
涓??㈣?寸???芥???ㄤ唬???????㈡?炬敞??锛?Doxygen涔???璁稿?ㄥ?跺??浠讳??版?规敞??锛?浣?浠ｄ环??瑕?浣跨?ㄧ??????戒护??
Structural commands (like all other commands) start with a backslash (
\
@
Test
/*! \class Test
\brief A test class.
A more detailed class description.
*/
\class
Test
-
\struct
-
\union
-
\enum
-
\fn
-
\var
-
\def
-
\typedef
-
\file
-
\namespace
-
\package
-
\interface
To document a member of a C++ class, you must also document the class itself. The same holds for namespaces. To document a global C function, typedef, enum or preprocessor definition you must first document the file that contains it (usually this will be a header file, because that file contains the information that is exported to other source files).
Let's repeat that, because it is often overlooked: to document global objects (functions, typedefs, enum, macros, etc), you?must?document the file in which they are defined. In other words, there?must?at least be a
/*! \file */ /** @file */ line in this file.
渚?瀛?锛?
/*! \file structcmd.h
\brief A Documented file.
Details.
*/
/*! \def MAX(a,b)
\brief A macro that returns the maximum of \a a and \a b.
Details.
*/
/*! \var typedef unsigned int UINT32
\brief A type definition for a .
Details.
*/
/*! \var int errno
\brief Contains the last error code.
\warning Not thread safe!
*/
/*! \fn int open(const char *pathname,int flags)
\brief Opens a file descriptor.
\param pathname The name of the descriptor.
\param flags Opening flags.
*/
/*! \fn int close(int fd)
\brief Closes the file descriptor \a fd.
\param fd The descriptor to close.
*/
/*! \fn size_t write(int fd,const char *buf, size_t count)
\brief Writes \a count bytes from \a buf to the filedescriptor \a fd.
\param fd The descriptor to write to.
\param buf The data buffer to write.
\param count The number of bytes to write.
*/
/*! \fn int read(int fd,char *buf,size_t count)
\brief Read bytes from a file descriptor.
\param fd The descriptor to read from.
\param buf The buffer to read into.
\param count The number of bytes to read.
*/
#define MAX(a,b) (((a)>(b))?(a):(b))
typedef unsigned int UINT32;
int errno;
int open(const char *,int);
int close(int);
size_t write(int,const char *, size_t);
int read(int,char *,size_t); ? 浣?杩?涔?澶??????ㄦ???搴?璇ヤ?浼??ㄥ?帮???涓鸿?浜?娉ㄩ????????????涓?涓?浜轰??荤?????? ??涓?锛?????????瑕???娉ㄩ??灏卞?浜?锛??充?浜х??涓哄??绉??煎?????妗ｆ??浠ュ????浜???锛???姝ら??缃?涔??????ㄦ?跺??琛ヤ??? Doxygen绠???缁?楠?璋?
Doxygen绠???缁?楠?璋?
?? ? ??Doxygen锛? 澶у??榧?榧?????妗ｇ????宸ュ?凤?琚?Boost??OpenCasCade绛?璇稿?椤圭??浣?涓烘??妗ｇ??????涓?浜?浜洪????浜鸿?达?????妯?婧㈠?寰???楂?娣辫??娴?锛?杩??ヨ???惧??Doxygen杩????剧?舵??涓????ㄧ??????????姝??烘?锋?风簿????Doxygen锛??村??????绠????????浠?澶村?板熬??涓?涓?瀹????虹????妗ｏ??充?浼??ㄩ?介?俱??????
?? ? ?瀚????辨??楹荤????锛?杩?????涓?绡?涓??????ラ?ㄤ?缁??? 绠?????璇达?濡???浣???澶??ㄩ」??涓?????oxygen浣?涓烘??妗ｇ??????宸ュ?凤?棣???锛?浣???瑕?浜?瑙ｏ?Doxygen??瑕?浠?涔??风??浠ｇ??缁??????藉???浜ф??妗ｃ?? Doxygen?烘??涓?瀵瑰??绉?绉???浠ｇ??涓????磋叮锛?浣???瑕??ㄦ??????绫汇???芥?般???????芥?般?????卞????????瀛?绌洪?寸??浠ｇ??宸叉??琛ㄧず??缁???涓??规坊??涓???瀹??煎???娉???锛?Doxygen???借?????烘?ャ??姝ゅ?锛?浣?杩???浠ユ???ф??瀹??煎???娉ㄩ??娣诲????????淇℃??锛??ㄤ互????妯″??????绫伙??舵???句?绫荤??淇℃????Doxygen??????娉ㄩ????寮?澶?绉?澶??凤?寮虹??寤鸿???跺??涓?涓?缁?涓???????锛?????浼?缁?椤圭??涓??朵???浜哄?????????ョ??浜哄??甯??ュ?澶????版?般??????
?? ? ? ???ф??瀹????煎?涔???浜?娉ㄩ??涔???锛?灏遍??瑕???涓?涓?Doxygen????缃???浠讹?渚??ф?ら??缃???浠讹?Doxygen??浠ョ??浜?TML??Tex??XML绛?澶?绉??煎?杈?????妗ｃ??Doxygen????缃???浠讹???杈??╃??GUI宸ュ?峰府?╀功??锛?浣?????瑕??瑰??涓???椤癸??瑰??涓?????灏变俊?????ヤ???浣??ㄦ?ゅ己??寤鸿??锛?浣?搴?璇ユ??Doxygen姣? 涓?涓???缃??肩????涔??戒?瑙ｄ?涓?锛???涓?浜?绠?????渚?瀛?瀹?璺典?涓?锛?杩??蜂???浣???浠ユ?妤??????戒???瑕????煎?璇ュ?浣???缃??烘?ワ?浜???浣???浠ュ????浜?瑙?oxygen??浠ュ?? ?颁?涔?绋?搴??浠ュ?涓??朵?????????
?? ? ?Doxygen??甯告???ㄤ??????辨????妗ｇ??锛?????涓?????妗ｉ??瑕?淇??硅??ュ??杈??虹?????讹?杩??峰??浠ユ?瑰??瑙ｆ???瑰?锛?????涓?????妗ｃ??浣???锛?浣?蹇?椤绘??璇? ?帮?Doxygen?ㄤ?娉ㄩ??涓??藉??淇℃??????瑕???璇?娉?瑙ｆ????锛?杩?浜?瑙ｆ???芥???轰??辨?????虹?锛?涓????藉?ㄨ?涓?灞????????涓?????姣?濡?锛?涓?涓?绫荤??绠???淇℃????璇??淇℃?? ??????锛?????杩??辨?????ュ?封??.???ヨ??????锛?濡???浣??ㄤ腑?????ュ?封??????锛?Doxygen灏卞??杈ㄤ??烘?ヤ?????姣?濡?锛??ㄦ??涓?绫荤??娉ㄩ??涓?锛?浣??? Created by xxx function锛??朵腑xxx????涓??规???锛?Doxygen浼??ㄧ????????妗ｄ腑锛????ㄤ负璇ュ?芥?版坊??涓??炬?ャ??褰?濡???浣??ㄤ腑??锛?璇ョ被??琚?xxx?规??????烘?ョ???? Doxygen灏辨??娉??藉???鸿?ヤ俊??骞舵坊涓??炬?ャ??浣?瑕???濡?涓? ?煎??ュ??锛?璇ョ被??琚? xxx ?规??????烘?ョ?????ㄥ己琛???浜鸿??绌烘?煎府??oxygen??????绫讳技????棰??藉??浠ヤ互姝ょ被?ㄣ??????
?? ? ? ??浠?璇达?Doxygen??娉?璇?????绉?绉???浠ｇ??淇℃??锛?杩?骞朵????崇??浠ｇ??缁???瀵?oxygen?ヨ?翠???瑕???Doxygen??浠ュ?瑰??绉?璇?瑷?涔?????浠ｇ??杩?琛?浼???锛? 姣?濡?浣?寮???C++浠ｇ??浼?????锛?Doxygen浼?瑙ｆ??浣?????C++浠ｇ??锛?娣诲???村??村?蜂???淇℃??锛?骞朵??т??磋??绯讳负浣?娣诲???炬?ャ??杩?涔?灏辨??璇达?Doxygen浼? 浜х????瀹???浠ｇ??缁???琛ㄧず?烘?ョ??涓?瑗匡?浣??ㄥ??娉ㄩ?????跺??涔?搴?璇ユ???т弗璋ㄧ??浠ｇ??缁????诲????姣?濡?锛?浣??ㄦ??涓?绫???娉ㄩ??涓?????锛?姝ょ被?ㄥ?颁? B 绫讳腑???规?????璁?杩?涓?绫伙??ㄥ??瀛?绌洪??1??锛?濡???锛?浣???A绫诲???蜂?????1??锛?杩?涓??炬??oxygen浼?涓轰????ㄦ坊??锛?浣???锛?濡???B杩?涓?绫诲?ㄥ??瀛?绌洪??N2??锛?Doxygen浼???瑙?浣???璇锋???浣?蹇?椤讳弗?肩????瀹????ㄥ?? N2::A锛?Doxygen??浼?娆ｇ?舵?ュ??杩?涓?濞???????
?? ? ? ???ㄥ????椤圭??姣?杈?灏?锛???姝ゆ???╃??oxygen??ToDo-List??Bug??琛ㄥ?归」??杩?琛?绠?????绠＄????姣?濡?锛???涓?涓?绫讳???涓?浜???缁???宸ヤ?娌℃??瀹???锛?浣??? 浠ュ?ㄥ?舵敞??涓???涓?@todo xxx锛?锛?杩??????朵腑涓?绉?璇?娉?锛?涓?????涓???瑙???...锛?Doxygen浼?灏??堕?炬?ユ坊???颁?涓?to do list涓?锛?骞朵负璇?o do list????涓?涓?椤甸????ョ??璧锋?ラ?涓烘?逛究?????凤?Bug??璁颁???杩?涔??ㄨ?涔?????锛?涓句???涓?澶у?堕?戒?锛???灏变?澶?纾ㄥ?戒???????
?? ? ? Doxygen涓??╃?ㄥ?板?澶?绗?涓??圭???轰?缂?璇???淇℃??????宸ュ?凤?杈??╃?????翠负????????妗ｃ??姣?濡?锛?浣???浠ュ?ㄦ敞??涓?宓??ョ????tex????????寮?锛?Doxygen甯??╀???杩?浜??剧ず?颁?????妗ｄ腑?ワ?浣?杩???浠ヤ负浣?????妗ｈ???ㄧ????缁ф?垮?撅?缁????撅?UML?煎????撅?绛???绉?榻??ㄧ???撅???瑕?浣???Graphviz瑁? 涓?锛?骞舵??寮??稿?冲???板?冲?????存?浜?????锛??╃??raphviz??dot?规?锛?浣???浠ュ?绗????舵?煎????诲?炬??浠ゅ???ㄦ敞??涓?锛??烘???撅??舵???撅?娴??撅?浜や??撅???澹? ?￠?垮??娉?璺虫ゼ?撅???瑕?浣??界??raphviz?诲?猴?Doxygen?借?界?浣??ㄤ?锛??句??虫?瑰氨?规?冲??灏卞??锛?骞哥???娲伙?涓?杩?灏?灏??????充?Graphviz锛?g9??澶у凡缁??ㄨ??杩? 浜?锛???澶???濂借??涔?灏辨?惧????姐??杩?涓?瑗挎??????濂戒?瑗匡??逛究??涓?濉?绯?娑?锛?瀵逛?甯稿勾??浠ｇ????浜ら??瀵圭?磋?涔??╃己澶卞?ゆ????绋?搴?????瑷?锛?杩???????灞?瀹舵??琛???浜哄?澶???姘???????浣?瑕???姘存?????╃?????冲??澶у??浼肩??锛?????瑕?涓?淇???????锛?????杩??蜂?????????澶?锛?灏卞???藉?虫敞???借????娉?????缇?瑙?浜???????
?? ? ? ?朵???淇℃??锛?姣?濡?author锛?date锛?group锛?涔?绫荤??锛????戒?瑕?姹???娉ㄩ?????跺????涓?锛?涓炬??涔??筹???浠ユ?逛究寰?澶???缁????藉?虹?扮????棰???姣?涓?涓?绠????版?? ??娉ㄩ?????芥?帮?涔?瑕???涓?涓?绌虹??娉ㄩ??澶达?浠ヤ究??????妗ｇ???跺??锛????????规??介?澶?锛?濡???????瑕?锛?浣???浠ヤ慨?归??缃???浠剁??璁剧疆锛???浠ｇ??涔?缁?瀹?杩???妗ｏ?杩??峰??浜哄??瑕? ?跨????妗ｄ???锛???涔?灏卞???ㄤ??ㄥ?ㄦ坊涓?浠戒唬???惧?ㄦ??涓?浜???????
?? ? ? ?????妗ｄ?浠ｇ??缁?瀹??ㄤ?璧凤?杩?????oxygen涔?绫诲伐?风??涓?涓?濂藉?锛?瀹??冲???浠ヤ骇??涓や釜?归?㈢????浜у????涓??归???瀹???浠ュ府?╀???寤虹?????濂界????妗ｏ???????姝?????濂界??????妗ｆ?ワ?????归???瀹???浠ュ?烘?浣??存?版??妗ｏ?????妗ｅ伐?峰?浣?椤圭??绠＄??宸ュ?风?ㄨ捣?ャ??褰??讹?濡?????妗ｅ氨?ㄤ?????浠ｇ??涓???袱琛?浣??芥??????涓??硷??ｄ?锛???宸ュ?蜂??芥??涓?浜?浜????ㄨ?绫诲伐?凤?蹇?椤昏???妗ｄ唬??????????锛?????????锛???瀹??????板????????娴?璇?涓?涓?涔???绾у???ワ???涓??兼敞??锛???涓?娈典唬??锛??跺??娴?涓?娴?锛??规?硅? ??娉ㄩ??锛?灏卞???搁?卞?烽ゼ??榛???涓??蜂?姘??垫??锛??ｄ?锛?Doxygen灏卞??浠ヤ?澶???姊??浼?绗?浜???????
C++ 绋?搴???妗ｇ?????ㄤ?缁?(doxygen)
绋?搴???妗ｏ??剧???绋?搴?????涓?涓?澶寸????棰?????涓?涓?绋?搴???妗ｏ?姣?杈??辨?堕?达?浣?涓???寰??撅?楹荤??????褰?绋?搴?淇??瑰??锛?绋?搴???妗ｄ?瑕?璺?????姝ユ?存?帮???????妗ｅ??绋?搴?灏辫??辫??锛???妗ｄ?灏卞????娌＄?ㄧ??涓?瑗夸???
濂藉?ㄦ??璁稿?濂界?ㄧ????妗ｇ?????ㄦ?ヨВ?宠?涓???棰???????姣?杈?娴?琛???C++??妗ｇ?????ㄦ??doxygen??
????灏辩??????浠?缁?涓?涓?doxygen????妗ｆ敞???规?锛?浠ヤ???瀛???????锛?
C++ 绋?搴???妗ｇ?????ㄤ?缁?(doxygen)?????娌???缃?蹇?
1.?妯″??瀹?涔?锛??????剧ず涓?椤碉? ? ?... 瀹?涔?????瀹?... ? // 妯″??缁?灏? ? 2.???缁?瀹?涔?锛??ㄤ?椤靛????缁??剧ず锛? ? ?... 瀹?涔?????瀹?... ? ? 3.???????瀹?瀹?涔???绫诲??瀹?涔?绠?瑕?璇存?? #define FLOAT float ? #define MIN_UINT 0 ? int?b; ? 4.??芥?拌?存?? int?func(int?param1,?int?param2); ? int?OpenFile(const?char*?file_name,?const?char*?file_mode); ? 5.???涓剧被??瀹?涔? typedef?enum?TDayOfWeek { SUN?=?0,? MON?=?1,? TUE?=?2,? WED?=?3,? THU?=?4,? FRI?=?5,? SAT?=?6?? } TEnumDayOfWeek;?? ???? 6. 椤圭??绗??锋??璁? ? ?
缁???涓猴?
A list of events:
- mouse events
- mouse move event
-
mouse click event
More info about the click event.
- mouse double click event
- keyboard events
- key down event
- key up event
More text here.
浠ｇ??绀鸿??锛?
? // ????ㄦ敞????妗ｈ??渚?
??????chm??妗ｆ???撅?
??渚?涓?杞斤?
/Files/ly4cn/doxygen_example.rar http://www.cnblogs.com/ly4cn/archive/2005/11/23/282637.html