如何插入VS XML注释代码

开发 后端
所有的VS XML注释都在三个向前的斜线之后,两条斜线表示是一个注释,编译器将忽略后面的内容,三条斜线告诉编译器,后面是VS XML注释,需要适当地处理。

本文主要讲述VS XML注释,怎样是源代码插入VS XML注释,如何把VS XML注释输出为有用文档,这些内容都是一些门户网站和技术论坛找到的,欢迎大家学习切磋交流。。

C# 允许开发人员在源代码中插入VS XML注释,这在多人协作开发的时候显得特别有用。 C#解析器可以把代码文件中的这些XML标记提取出来,并作进一步的处理为外部文档。 这篇文章将展示如何使用这些VS XML注释。作者演示了如何生成工程,如何把VS XML注释输出为有用文档,如何把这些注释转变为帮助文件。 在项目开发中,很多人并不乐意写繁杂的文档。

但是,开发组长希望代码注释尽可能详细;项目规划人员希望代码设计文档尽可能详尽;测试、检查人员希望功能说明书尽可能详细等等。 如果这些文档都被要求写的话,保持它们同步比进行一个战役还痛苦。 #t#

为何不把这些信息保存在一个地方呢??最明显想到的地方就是代码的注释中;但是你很难通览程序,并且有些需要这些文档的人并不懂编码。

这篇文章将展示如何通过使用VS XML注释来解决这些问题。代码注释、用户手册、开发人员手册、测试计划等很多文档可以很方便的从VS XML注释中获得。我将先演示如何插入XML注释、如何把这些XML注释导出为另一个文档。然后再讨论每个XML标记的意思,以及使用XML和XSL生成帮助文件。
所有的XML注释都在三个向前的斜线之后(///)。两条斜线表示是一个注释,编译器将忽略后面的内容。三条斜线告诉编译器,后面是VS XML注释,需要适当地处理。

当开发人员输入三个向前的斜线后,Microsoft Visual Studio .NET IDE 自动检查它是否在类或者类成员的定义的前面。如果是的话,Visual Studio .NET IDE 将自动插入注释标记,开发人员只需要增加些额外的标记和值。下面就是在成员函数前增加三个斜线,自动增加的注释。代码如下:

  1. /// <summary> 
  2. ///  
  3. /// </summary> 
  4. /// <param name="strFilePath"></param> 
  5. public void LoadXMLFromFile(string strFilePath)  
责任编辑:chenqingxiang 来源: chinaitlab
相关推荐

2009-12-04 10:02:32

VS XML注释

2009-12-04 10:28:48

VS宏代码

2018-12-19 17:20:17

2020-10-22 09:09:41

Python数据科学代码

2022-06-06 12:02:23

代码注释语言

2009-08-17 15:34:58

C#创建XML

2010-08-05 13:45:57

存入DB2 代码

2014-11-26 14:46:47

代码

2010-01-08 13:42:21

JSON VS XML

2009-12-11 16:39:59

VS 2008 XML

2014-09-12 10:38:01

程序员代码

2015-10-26 09:38:52

避免注释代码

2015-10-20 15:59:57

注释代码程序

2012-11-30 11:26:00

代码注释

2014-11-14 17:08:24

代码

2021-09-07 10:55:36

SQLitePythonRust

2021-04-08 10:55:53

MySQL数据库代码

2021-10-26 10:30:31

代码编辑器LinuxVS Code

2023-08-28 15:52:10

LinuxPDF

2015-06-16 13:27:31

代码注释代码
点赞
收藏

51CTO技术栈公众号