让C++拥有C#中XML的注释格式

简介: 转自博客:http://dongtingyueh.blog.163.com/blog/static/4619453201242910245951/ 在C#中,如果要在要注释的函数前面加上”///”,那么,系统会自动生成几行代码,如下所示:         /// ...

转自博客:
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文件,在VSObjectBrowser中显示函数的注释。具体操作为:

工程属性—C/C++ --输出文件生成XML文件()

XML注释格式:

预定义的标签:

 将说明中的文本标记为代码

 提供了一种将多行指示为代码的方法

 指定使用方法或其他库成员的示例

 允许你指定可能发生的异常类

 允许你引用描述源代码中类型和成员的另一文件中的注释使用 XML XPath 语法来描述你的源代码中的类型和成员。

 XML注释文档中插入一个列表

 XML注释文档中插入一个段落

 描述一个参数

 提供了一种指示一个词为参数的方法

 允许你将成员的访问许可加入到文档中

 用于添加有关某个类型的信息

 描述返回值

 指定链接

 指定希望在请参见一节中出现的文本

 类型或类型成员的通用描述

 描述属性

例如:

        /// 

        /// 该方法实现图像大小的返回

        /// 

        /// 描述图像流的长度

        /// 

        public static int Fuc2(int a)

        {

            return a;

        }

这个例子中如果有多个参数,则依次书写如下:

/// 描述图像流的长度

/// 描述图像流的长度

……

最后,看到这里的兄弟们,帮个忙,有机会帮我刷下淘宝店,谢啦!淘宝店名:小糊涂神儿,地址 http://shop105827674.taobao.com ,新开小店,信誉第一, 话费点卡 应有尽有哦!
相关文章
|
12天前
|
XML Java 数据格式
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
本文介绍了在使用Spring框架时,如何通过创建`applicationContext.xml`配置文件来管理对象。首先,在resources目录下新建XML配置文件,并通过IDEA自动生成部分配置。为完善配置,特别是添加AOP支持,可以通过IDEA的Live Templates功能自定义XML模板。具体步骤包括:连续按两次Shift搜索Live Templates,配置模板内容,输入特定前缀(如spring)并按Tab键即可快速生成完整的Spring配置文件。这样可以大大提高开发效率,减少重复工作。
使用idea中的Live Templates自定义自动生成Spring所需的XML配置文件格式
|
4月前
|
XML JSON 数据处理
C# 中的 XML 与 JSON 数据处理
在现代软件开发中,数据交换和存储需求日益增长,XML 和 JSON 成为最常用的数据格式。本文从 C# 角度出发,详细介绍如何处理这两种格式,并提供示例代码。对于 XML,我们介绍了读取、创建和写入 XML 文件的方法;对于 JSON,则展示了如何使用 Newtonsoft.Json 库进行数据解析和序列化。此外,文章还总结了常见问题及其解决方案,帮助开发者更好地应对实际项目中的挑战。
201 61
C# 中的 XML 与 JSON 数据处理
|
2月前
|
存储 编译器 Linux
【c++】类和对象(上)(类的定义格式、访问限定符、类域、类的实例化、对象的内存大小、this指针)
本文介绍了C++中的类和对象,包括类的概念、定义格式、访问限定符、类域、对象的创建及内存大小、以及this指针。通过示例代码详细解释了类的定义、成员函数和成员变量的作用,以及如何使用访问限定符控制成员的访问权限。此外,还讨论了对象的内存分配规则和this指针的使用场景,帮助读者深入理解面向对象编程的核心概念。
154 4
|
4月前
|
物联网 C# C语言
物联网开发中C、C++和C#哪个更好用
在物联网(IoT)开发中,C、C++和C#各有优缺点,适用场景不同。C语言性能高、资源占用低,适合内存和计算能力有限的嵌入式系统,但开发复杂度高,易出错。C++支持面向对象编程,性能优秀,适用于复杂应用,但学习曲线陡峭,编译时间长。C#易于学习,与.NET框架结合紧密,适合快速开发Windows应用,但性能略低,平台支持有限。选择语言需根据具体项目需求、复杂性和团队技术栈综合考虑。
|
3月前
|
XML 存储 缓存
C#使用XML文件的详解及示例
C#使用XML文件的详解及示例
130 0
|
3月前
|
XML JSON 前端开发
C#使用HttpClient四种请求数据格式:json、表单数据、文件上传、xml格式
C#使用HttpClient四种请求数据格式:json、表单数据、文件上传、xml格式
665 0
|
5月前
|
存储 数据可视化 C++
【C++】C++-机房收费管理系统(源码+注释)【独一无二】
【C++】C++-机房收费管理系统(源码+注释)【独一无二】
|
7月前
|
存储 C# 开发者
C# 编程基础:注释、变量、常量、数据类型和自定义类型
C# 编程基础:注释、变量、常量、数据类型和自定义类型
|
7月前
|
Java Go C#
编程语言C#、C++、Java、Python、go 选择哪个好?
我想说的是,不论选择哪种编程语言,决定选择的都是你最终的目的,做选择之前,先充分调研每一个选择项,再做选择思路就会非常清晰了。
144 3
|
7月前
|
C++ 编译器
C++中的注释作用
C++ 代码中的注释可提高可读性,有单行和多行两种形式。单行注释以 `//` 开始,多行注释用 `/* ... */` 包裹。`#if 0 ... #endif` 用于条件编译,可实现可屏蔽的代码块,常用于调试。`#if` 后可跟条件表达式,在满足条件时执行相应代码。