转自博客:
http://dongtingyueh.blog.163.com/blog/static/4619453201242910245951/
在C#中,如果要在要注释的函数前面加上”///”,那么,系统会自动生成几行代码,如下所示:
///
///
///
///
///
public static int Fuc2(int a)
{
return a;
}
这几行代码就是生成xml的注释,你可以在这个地方进行注释,编译后就可以在工程的bin/debug文件夹路径中生成一个xml文件,里面放置的就是你的注释内容。同时,在工程的ObjectBrowser即“对象浏览器”中,你也可以方便的查找到对应函数的注释。
在C++/C编程中,一般是需要我们自己书写说明文档的。但是,在Visual Studio中,我们可以在C++工程—属性中进行设置,让C++一样可以使用C# 的风格书写注释,并在相应路径中生成一个xml文件,在VS的ObjectBrowser中显示函数的注释。具体操作为:
工程属性—C/C++ --输出文件—生成XML文件(是)。
XML注释格式:
预定义的标签:
将说明中的文本标记为代码
提供了一种将多行指示为代码的方法
指定使用方法或其他库成员的示例
允许你指定可能发生的异常类
允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。
向XML注释文档中插入一个列表
向XML注释文档中插入一个段落
描述一个参数
提供了一种指示一个词为参数的方法
允许你将成员的访问许可加入到文档中
用于添加有关某个类型的信息
描述返回值
指定链接
指定希望在“请参见”一节中出现的文本
类型或类型成员的通用描述
描述属性
例如:
///
/// 该方法实现图像大小的返回
///
/// 描述图像流的长度
///
public static int Fuc2(int a)
{
return a;
}
这个例子中如果有多个参数,则依次书写如下:
/// 描述图像流的长度
/// 描述图像流的长度
……
最后,看到这里的兄弟们,帮个忙,有机会帮我刷下淘宝店,谢啦!淘宝店名:小糊涂神儿,地址 http://shop105827674.taobao.com ,新开小店,信誉第一, 话费点卡 应有尽有哦!