【大家都来谈谈你们是怎么写VC文档的，使用那些自动提取注释的工具？】

Question

我想大家不会专门去写文档吧，一般多是用工具自动提取程序中的注释形成文档。都使用什么工具呢？我只看到过一个叫DOC++的工具，不知道怎么样？来讨论讨论吧

Answer 1

http://blog.joycode.com/jiangsheng/archive/2005/11/05/66471.aspx

Answer 2

恩,楼上说的是
不过刚开始的时候一般都是先写代码后写注释的~~~楼主还是养成良好的习惯比较好
DOC++什么东西?没用过

Answer 3

to  jiangsheng(蒋晟.Net) :
我们开发用的是.net2003,而且是vc，你那个好像是在.net2005的c#中使用的吧？

Answer 4

……是在Visual C++ 2005里面使用XML注释……你是不是把C++和C#搞混了？

Answer 5

兄弟，请搜索doxygen，看看帮助，你就会了，使用doxygen 撰文/ K. Young          翻译/马维达（已发表在《程序员》2002年第3期上）一、介绍GLAST软件已采用doxygen（GNU GPL软件）来作为文档工具，本文将对其进行简单的介绍。要了解更详细的信息及下载doxygen程序，请访问网站http://www.stack.nl/~dimitri/doxygen/。什么是doxygen呢？下面的介绍录自doxygen的网页：“doxygen是一种用于C++、IDL（Corba、Microsoft和KDE-2 DCOP风格）和C的文档系统。它可以通过三种方式来帮助你：1.        它可以从一组标有文档的源文件中生成在线文档浏览器（HTML格式），以及/或者离线参考手册（LATEX格式）。同时还支持生成RTF（MS-Word）、Posts cript、超链接PDF、压缩HTML和UNIX man页面格式的输出。文档是从源文件中直接提取的，从而十分容易保持文档和源码的一致。2.      可配置doxygen，用以从没有标注文档的源文件中提取代码结构。这对于要在大量源文件中快速地找到所需的东西来说是非常有用的。通过include依赖图、继承图和协作图等手段（它们都是自动生成的），可以使不同成分之间的关系可视化。3.      你甚至还可以“滥用”doxygen，创建普通文档。”二、doxygen注释风格使用doxygen的第一步是在你的代码中插入doxygen风格的注释。你可以使用两种不同风格的doxygen注释：Qt风格，专用文档块看起来是这样的：
/*!
... text ...
*/还有单行版本：
file://! ... one line of text ... 
JavaDoc风格，专用文档块看起来是这样的：
/**
  * ... text ...
  */还有单行版本：
/// ... one line of text ...
从现在起我将在例子中使用Qt风格，但是你可以在你的代码中使用任何一种。你可以通过许多方式使用doxygen注释，以为你的代码编写文档。但下面的一种，我们感觉能够令人满意地工作。注意下面的注解仅仅说明应该如何使用doxygen注释；你所应该包含在注释里的信息是另外一回事，并不在这里进行讨论。我们的基本想法是你想要为每个类、以及该类的重要成员函数增加短注释和长注释。短注释应给出类或函数的基本信息的简要描述。而较长的注释，不奇怪，应该给出更长和更完整的描述。类的短注释和长注释，以及成员函数的简短描述，将放在头文件中。成员函数的长注释将出现在成员函数的实现出现的地方。下面的例子演示这一注释系统（向Alexandre、Regis和Jose道歉，我在此过程中“黑”了他们的代码）。假定我们正在为一种叫作CalPack 的CMT包工作，它有一个单独的类CsICluster，头文件叫作CsICluster.h，在CalPack/目录中；而实现文件叫作CsICluster.cpp，在src/目录中。文件CalPack/CsICluster.h是这样的：而文件src/CsICluster.cpp是这样的：注意，你可能会选择省略那些含义清楚的成员函数的较长注释，这并不会导致任何问题。访问http://www.slac.stanford.edu/exp/glast/ground/software/doxygen_examples/v1/class_CsICluster.html可以看到上面被注释的代码所产生的HTML文档。三、使用mainpage.h文件浏览上面的链接中的文档，你可能会注意到名为“Main Page”的链接（它指向index.html）并不是十分有趣。这是一个特殊的页面，在这里你可以添加与你的doxygen页面描述的所有类有关的文档。在我们的例子中只有一个单独的类，但是你可以使用doxygen来处理如你所选择的那么多的类。一种自然的划分是为每一个GLAST CMT包都创建doxygen页面。于是合乎想像地，我们想要这个主页面成为对正在被讨论的包的描述；在我们的个案中就是CalPack包。那么我们怎么为此主页面增添内容呢？你需要使用doxygen的特殊命令\mainpage。在doxygen中有

Answer 6

下载地址：http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc