C#的XML代码注释

最新推荐文章于 2024-07-18 02:59:18 发布
最新推荐文章于 2024-07-18 02:59:18 发布
阅读量4.8k 收藏 2
点赞数 3
分类专栏： C# 文章标签： c# C# xml XML XML comment XML注释
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/tounaobun/article/details/8315859
版权
本文介绍了C#中特有的XML代码注释方式，用于在编译时生成XML文档，便于IDE提供类和方法的详细说明。通过示例展示了如何使用三根反斜杠进行注释，并解释了查看生成的XML文档的方法。
摘要由CSDN通过智能技术生成

在C/C++,JAVA中，有两种注释，一种是单行注释，即两根反斜杠(//)，另一种是多行注释，即以/*开头，以*/结尾。

在Java中，多行注释(Multiline Comment)分为两种形式:

1.普通多行注释,比如

/*
 *多行注释
 */

2.Javadoc注释,比如 

/**
  *Javadoc注释
  */

当Java源文件编译的时候，Javadoc工具会读取源文件当中的Javadoc注释内容，并生成相应的HTML文档。供开发者参阅API相关的内容。


在C#中采用了另外一种形式，即XML。

为了能够在编译过程中生成XML文档，需要一种来标记来标注注释。即三根反斜杠。

下面是一个简单的例子:</

最低0.47元/天 解锁文章
czjuttsw
关注
专栏目录
C# 代码 XML 注释规范及其 .chm 帮助文档生成
Devin的博客
03-06 2631
一.摘要 当我们进行程序开发时，面对一个大型项目，需要多人分工合作，每人实现一个模块。当我们需要调用他人编写的模块时，首先参考的不是源码部分，而是要去通读其代码注释部分。因此，代码注释是否规范标准，很大程度上影响着项目的开发进度。 .Net允许开发人员在源代码中插入XML注释，这在多人协作开发的时候显得特别有用。C#解析器可以把代码文件中的这些XML标记提取出来，并作进一步的处理为外部文档。在...
C# LinqXML添加注释到XML文件
10-27
亲测好用，利用MS c# 的LinqXML技术 添加注释到XML文件。
C#使用XML文件的详解及示例
最新发布
weixin_34094559的博客
07-18 70
前言XML是 Extensible Markup Language 的简称，用于存储和传输数据的可扩展标记语言。它被应用在数据交换、数据存储、Web服务、网络协议等场景。XML 具有可扩展性、结构化、标准化、简单易读等几个特点。基本结构XML 基本结构包括文档声明、根元素、子元素、属性、注释、处理指令等部分。登录后复制 ...
C#中的XML注释
Eray的专栏
12-08 5221
C#中的XML注释注:转载自http://hi.baidu.com/czlaner/blog/item/aa9251d35e7005033af3cfce.html 　　上篇文章提到过如何使用Sandcastle创建C#的帮助文档，这需要在源文件中插入XML注释，以“///”的形式出现。C#的“///”注释在编译生成xml时候被抽取出来，是用Sandcastle自动生成CHM帮助文档必不
XML文档注释（C#）
CSDN博客
10-19 1129
XML文档 编译器识别的标记 添加XLM注释的方法 添加XLM注释的例子 目录XML文档编译器识别的标记添加XLM注释的方法添加XLM注释的例子 XML文档 C#可以根据特定的注释自动创建XML格式的文档说明。 这些注释都是单行注释，但都以三条斜杠开头 编译器识别的标记 标记 说明 <C> 把行中的文本标记为代码，例如<c>int i=10;</c> <code> 把多行标记为代码
在C#使用XML注释
junmail的专栏
05-26 283
简介 大多数程序员可能都听说过Java自带的一个工具JavaDoc;使用它可以自动地为你的代码生成HTML文档。C＃和C＃编译器也有类似的功能，不过它生成的是XML，而不是直接生成HTML。不过使用XML会使得文档更加灵活。 注释语法 为了使用C＃提供的XML注释功能，你的注释应该使用特殊的注释语法（///）开头。在///之后，你可以使用预先定义的标签注释你的代码，也可以插入你自己定义的标签。你定...
.NET -> c# 注释的正确的使用方法
天外有天，人外有人。 专注品质 不断创新 让精益求精成为习惯
11-12 996
C# Coding的时候，常常涉及代码注释，常见的注释包括两类： 1）单行注释。格式：// Comments 2）多行注释。格式：/* Comments... */ C#引入了新的XML注释，即我们在某个函数前新起一行，输入///，VS.Net会自动增加XML格式的注释，这里整理一下可用的XML注释。 XML注释分为一级注释（Primary Tags）和二级注释（Secondary Tag
C#的XML两种代码注释实例说明
01-20
1.普通多行注释,比如 代码如下:/* *多行注释 */2.Javadoc注释,比如 代码如下:/** *Javadoc注释 */当Java源文件编译的时候，Javadoc工具会读取源文件当中的Javadoc注释内容，并生成相应的HTML文档。供开发者参阅API...
InheritDoc：允许添加C＃中XML注释的标签
02-06
允许在C＃源代码的XML注释中添加标记，以从基类，接口和类似方法继承XML注释。 消除不必要的复制和粘贴重复的XML注释，并自动保持XML注释同步。 XML注释（以///开头）通过常规构建过程被编译成每个程序集的XML文档...
C#代码生成XML自带注释
11-29
C#代码生成XML自带注释。
C#XML注释
adjyg64215的博客
12-17 109
注释 <c> 将说明中的文本标记为代码 <code> 提供了一种将多行指示为代码的方法 <example> 指定使用方法或其他库成员的示例 <exception> 允许你指定可能发生的...
C# XML注释
yi_life的博客
12-13 928
在C＃使用XML注释 简介 大多数程序员可能都听说过Java自带的一个工具JavaDoc；使用它可以自动地为你的代码生成HTML文档。C＃和C＃编译器也有类似的功能，不过它生成的是XML，而不是直接生成HTML。不过使用XML会使得文档更加灵活。 注释语法 为了使用C＃提供的XML注释功能，你的注释应该使用特殊的注释语法（///）开头。在///之后，你可以使用预先定义的标签注释你的代码，也可以插入...
C#读取XML时自动过滤掉注释部分
weixin_34117522的博客
01-10 243
C#在读取XML的时候会读取XML中的全部内容，对于其中注释掉的部分也可以通过节点获取到。 我们可以通过设置IgnoreComments 属性来只读取未加注释的XML信息。 下面是加载为参加注释的XML信息代码： 1: XmlDocument xmlDoc = new XmlDocument(); 2: XmlReaderSettings settings = ne...
C# XML 文档注释
weixin_34121282的博客
06-13 411
为什么80%的码农都做不了架构师？>>> ...
C#笔记：XML文档注释
闫小亘的博客
09-03 436
一、介绍 在 Visual C# 中，可以通过以下方法为代码创建文档：紧接在源代码中 XML 标记引用的代码块的前面，使用特殊的注释字段包括 XML 标记。 例如： /// <summary> /// This class performs an important function. /// </summary> public class MyClass{} 二、示例...
C#中的XML文档注解
hackershit的博客
11-13 681
C#中除了C风格的注释外，还提供了3条斜杠(///)开头的注释，在这些注释中，可以把包含类型和类型成员的文档说明的XML标记放在代码中。以下为标记说明: 标记 说明 < c> 把行中的文本标记为代码，例如 < c > int i = 10; < /c > < code> 把多行标记为代码 < example> 标记为一个代码示例 < exception> 说明一
XML--注解
lLlLlL__lL的博客
10-11 841
XML（可扩展标记语言）是一种用于存储和传输数据的通用标记语言。它使用自定义标签来描述数据的结构和内容。XML具有跨平台、可扩展和可读性强的特点，因此在各种应用领域广泛使用。通过XML，数据可以被精确地定义、验证和交换，使得数据在不同系统之间的传输和处理更加方便和可靠。XML已经成为许多领域的标准数据交换格式，例如Web Services、配置文件和文档存储。
XML注释
热门推荐
lz17267861157的博客
06-19 1万+
xml注释，以及一些基本操作
C# 文档注释规范与XML生成
C#编程语言中，文档注释是一种特殊形式的注释，旨在帮助程序员创建包含XML文本的元数据，这些元数据能够被工具用来生成结构化的XML文件，进一步用于创建API文档或其他形式的程序文档。这种注释方式允许开发者在代码...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值