◆◆◆有关C/C++注释的问题——是否有类似JavaDoc方式的C++注释存在？◆◆◆

Question

普通的C++注释即是这样:
// Comment
/*
 * Comment
 */
 
我近日发现一些洋人的代码的函数注释是这样写的:
//! DrawGrid
/*!
        \param UpdateRect [in] rectange to draw in
    
        \return void
 
        draw the background grid
*/多加了一个!号。有些编辑器对这种注释做出和普通注释不同的高亮，而且对\param、\return这些文档关键字也用不同颜色显示。试问老大们是否有这种类似JavaDoc的C++Doc文档规范存在？是否有关键字列表可供参考？

Answer 1

颜色的不同可以在VC的tools->option->format中进行定义。
注释的模板可以使用Visual assistant来辅助，例如，我定义的任何函数头部都要插入如下内容：
/*---------------------------------------------------------------------------------
* 函数功能：
* 参数说明：
*   返回值：无。
* 创建时间：liuxianzhi@2004/08/19 10:28
* 其它说明：无。
\*-------------------------------------------------------------------------------*/上面都是程序自动生成的。

Answer 2

我的意思是有些编辑器把 /* 和 /*! 当做不同的注释来处理（颜色不同），我已经看到不少X Window下面的编辑器是这样干的，不过国外是否把 /*! 当做C++Doc来处理？

Answer 3

打错了一个字：不知国外是否把 /*! 当做C++Doc来处理？

Answer 4

使用 vc++.net ，你就知道了，建立一个工程，menu-> 工具-> 生成 web 注释页

Answer 5

大家试试这个开源编辑器 SciTeWin32和X Window下有不同的版本，感觉不错，它就是这样处理的，所以我来问问

Answer 6

谢谢9731boy(发呆的上帝) ，看来是doxygen的功效