浅析C#文档自动化实现

C#文档自动化了解之前我们先来了解什么是C#文档自动化，熟悉java的程序员都知道，在java中有一种“文档注释”。采用这种注释之后，使用相应的命令，我们就可以得到与代码相关的文档说明。如今，在.net的世界中C#也提供了相同的功能。如果结合相应的工具，它还可以为我们产生漂亮的WEB风格的文档。

创新互联从2013年成立，先为延津等服务建站，延津等地企业，进行企业商务咨询服务。为延津企业网站制作PC+手机+微官网三网同步一站式服务解决您的所有建站问题。

C#文档自动化初步认识：

在C#中文档注释对应的符号是：///。但光使用它还是不能为我们产生代码文档，还必须使用特殊的标记才行。这些标记实际上是XML标记，最常用的是< summary >。例如：

 
 
 

  
  
  
/// 
  
  
  
  
 
  
  
  
/// A method with a string array param.  
  
  
  
 
  
  
  
///   
  
  
  
 
  
  
  
public void Koo(string[] ss) {}  
 
 
 

C#文档自动化的特点：

但是，并不是所有使用文档注释和这些标记的地方编译器都会为我们生成文档，它还会看这些标记是否与一些代码结构相关联。例如：

 
 
 

  
  
  
/// 
  
  
  
  
 
  
  
  
/// 不产生这行  
  
  
  
 
  
  
  
///   
 
 
 

就不产生任何文档。这些代码结构必须是：class, struct, enum, method, property, field, indexer, delegate, 或event.

C#文档自动化之产生文档的命令

◆命令行：csc /doc: ….xml …..cs；

◆如使用VS.net，则：项目 -> 属性 -> 配置属性 -> 生成 -> 输出 -> xml文档文件(在此填写文件名和路径)；

◆如要生成web注释：工具 ->生成注释 web......。

C#文档自动化的初步认识就向你介绍到这里，希望对你了解和学习C#文档自动化有所帮助。

【编辑推荐】

1. C#代码格式化实际应用解析
2. C#调用浏览器的功能实现浅析
3. C#调用浏览器的原理及实现浅析
4. C#文件浏览器制作的详细过程
5. C#货币格式转化实例解析

网页名称：浅析C#文档自动化实现
URL分享：http://www.gawzjz.com/qtweb2/news21/16721.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联