小小研究一下VC编译器cl.exe的文档生成功能

    俺电脑上装的VS2005,一次查cl.exe的帮助文档的时候,发现里面有个/doc的选项,可以将注释生成文档。于是小小测试了一下:
   cl.exe /doc"obj/MyClass.xdc"  /Fo"obj/MyClass.obj" src/MyClass.cpp

   源码里面以///开始的注释后的内容都会被提取出来当成文档,具体的标识与C#相同,如:
/// <summary>
/// 作为文档的注释
/// </summary>
class MyClass
{

};

   生成的xdc文件实际上是一个utf-8编码的XML文件,可以使用xdcmake.exe 将xdc文件编译成XML文件:
xdcmake.exe /out:"MyClass.xml" MyClass.xdc
   编译后的XML文件也是UTF-8编码的,而且内容和XDC文件几乎一致(好像只是顺序换了一下,搞这个编译似乎没什么意义)。

   相信用NDOC之类的工具能够把XML转换成CHM文件。

   和DOXYGEN比起来,cl.exe的文档生成功能有如下特点:
1、标记格式与C#一致,做过.NET的程序员应该会很喜欢;但是标记的数量和DoxyGen相比就差远了;
2、文档生成工具居然把C++的类型转换成了C#的类型!!!看来这个功能只是从C#的编译器顺手牵羊拿过来用的,根本不是为C++两声定做的。

    仍然支持DoxyGen,免费打广告一次。
 

你可能感兴趣的:(C++,c,xml,C#,vc++)