- 浏览: 1741265 次
- 性别:
- 来自: 成都
文章分类
- 全部博客 (520)
- Oracle (10)
- Oracle错误集 (8)
- Oracle安装升级 (15)
- Oracle日常管理 (51)
- Oracle字符集 (7)
- Oracle备份恢复 (24)
- Oracle优化 (4)
- Oracle编程 (52)
- Oracle导入导出 (19)
- Oracle体系结构 (15)
- Oracle网络 (2)
- Oracle安全 (2)
- Oracle权限 (3)
- Oracle数据字典和性能视图 (2)
- Oracle常用地址 (5)
- SQLPLUS专栏 (7)
- SqlServer (13)
- SqlServer2005编程 (27)
- SqlServer2005管理 (15)
- MySQL (20)
- Dorado应用 (1)
- C# (24)
- Arcgis Server开发 (20)
- ArcSDE技术 (19)
- UML学习 (2)
- 设计模式 (2)
- JAVA EE (4)
- JavaScript (3)
- OFBIZ (27)
- JAVA WEB开发 (22)
- Linux&Unix (34)
- SHELL编程 (14)
- C语言 (11)
- 网络协议 (14)
- FREEMARKER (2)
- GROOVY (2)
- JAVA语言 (3)
- 防火墙 (0)
- PHP (2)
- Apache (2)
- Loader Runner (1)
- Nginx (3)
- 数据库理论 (2)
- maven (1)
最新评论
-
怼怼怼怼:
oracle的timestamp类型使用 -
怼怼怼怼:
oracle的timestamp类型使用 -
怼怼怼怼:
oracle的timestamp类型使用 -
pg_guo:
感谢
oracle中查看用户权限 -
xu234234:
5、MapResourceManager控件中添加了两个服务, ...
北京ArcGis Server应用基础培训笔记1
简介
大多数程序员可能都听说过Java自带的一个工具JavaDoc;使用它可以自动地为你的代码生成HTML文档。C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML。不过使用XML会使得文档更加灵活。
注释语法
为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。
预定义的标签 用处
<c> 将说明中的文本标记为代码
<code> 提供了一种将多行指示为代码的方法
<example> 指定使用方法或其他库成员的示例
<exception> 允许你指定可能发生的异常类
<include> 允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。
<list> 向XML注释文档中插入一个列表
<para> 向XML注释文档中插入一个段落
<param> 描述一个参数
<paramref> 提供了一种指示一个词为参数的方法
<permission> 允许你将成员的访问许可加入到文档中
<remarks> 用于添加有关某个类型的信息
<returns> 描述返回值
<see> 指定链接
<seealso> 指定希望在“请参见”一节中出现的文本
<summary> 类型或类型成员的通用描述
<value> 描述属性
例子
下面的例子为我们常见的HelloWorld控制台应用程序添加注释:
using System;
namespace HelloWorld
{
/// <summary>
/// Sample Hello World in C#
/// </summary>
public class HelloWorld
{
/// <summary>
/// Console Application Entry Point
/// <param name="args">Command Line Arguments</param>
/// <returns>Status code of 0 on successful run</returns>
/// </summary>
public static int Main(string[] args)
{
System.Console.WriteLine("HelloWorld");
string name = System.Console.ReadLine();
return(0);
}
}
}
为生成XML注释文档,我们在调用csc编译源代码时使用/doc选项:
csc /doc:HelloWorld.xml helloworld.cs
生成的结果文档如下:
<?xml version="1.0"?>
<doc>
<assembly>
<name>XMlComment</name>
</assembly>
<members>
<member name="T:HelloWorld.HelloWorld">
<summary>
Sample Hello World in C#
</summary>
</member>
<member name="M:HelloWorld.HelloWorld.Main(System.String[])">
<summary>
Console Application Entry Point
<param name="args">Command Line Arguments</param>
<returns>Status code of 0 on successful run</returns>
</summary>
</member>
</members>
</doc>
HTML页面
你可能会问自己:我应该如何才能得到具有良好格式的HTML页面呢?很简单,你可以编写自己的XSL来转换生成的XML注释文档,或者使用Visual Studio.NET开发工具。通过使用VS.NET的【工具】菜单中的【生成注释web页】,你可以得到一系列详细说明你的项目或解决方案的HTML页面。下面就是通过VS.NET生成的注释helloWorld程序的HTML页面快照:
发表评论
-
C#正则表达式小结
2008-09-16 15:27 1594地址: http://www.cnblogs.com/m ... -
C#调用ORACLE存储过程返回结果集及函数
2008-07-22 17:49 2999ORACLE段: 首先在ORACLE建立PACKAGE和PA ... -
生成实体类的codesmith模版
2008-07-15 16:35 3142<%@ CodeTemplate Language=&q ... -
数据库开发个人总结(ADO.NET小结)(转)
2008-06-16 11:41 1974一.用SqlConnection连接SQL Server 1. ... -
ADO.NET—读书笔记系列
2008-06-16 11:37 1961ADO.NET概述 一、。NET数据提供程序 ... -
ADO.NET—DataHelper(转)
2008-06-16 11:24 3272using System; using System.Data ... -
ADO.NET—Asp.net 用DataSet对象更新数据(SqlDataAdapter)
2008-06-16 10:42 3508大家知道,DataSet保存的 ... -
一个简单的在程序中构造DataTable
2008-06-16 09:50 2410DataTable dt = new Data ... -
C# 中的委托和事件
2008-06-11 14:53 1087http://www.cnblogs.com/jimmyzha ... -
c#接口和抽象类的区别
2008-06-11 13:58 2570大家都容易把这两者搞 ... -
C#学习之接口
2008-05-26 16:17 1553什么是接口?其实,接 ... -
谈谈C#中的接口
2008-05-26 15:48 1225http://www.cnblogs.com/sifang20 ... -
C#构造函数
2008-05-26 15:27 4440一、C#构造函数?Construct,Function 构造函 ... -
关于构造函数及参数执行顺序说明(c#)
2008-05-26 15:08 3640以前自己对这方面的内容一直比较模糊,只是知道一个大概的顺序,具 ... -
C#继承小结
2008-05-26 14:48 16501、实例化父类时,可以使用new子类,执行构造函数顺序为:先执 ... -
C#修饰符
2008-05-26 14:30 1973符用于限定类型以及类型成员的申明,c#中有13种修饰符,按功能 ... -
C#命名规范
2008-05-26 13:49 2081注记 : Pascal 大小写形式 ... -
C#中处理xml文档
2008-05-26 11:53 1949C#下处理xml是通过XML.NET API类来实现的. XM ... -
Visual C# 编译器 CSC.EXE 参数详解
2008-05-26 11:29 4670Visual C#是微软公司推出的新一代程序开发语言,Visu ... -
C# 语句-循环语句
2008-05-26 11:08 3221本文将介绍如何使用C#控制语句中的循环语句,本文目的如下: 1 ...
相关推荐
亲测好用,利用MS c# 的LinqXML技术 添加注释到XML文件。
C#代码生成XML自带注释。
c#实现的xml解释程序,可以直接编译,加载xml文件后输出所有节点信息,稍加修改即可应用与自己的工程,方便工程应用。
允许在C#源代码的XML注释中添加标记,以从基类,接口和类似方法继承XML注释。 消除不必要的复制和粘贴重复的XML注释,并自动保持XML注释同步。 XML注释(以///开头)通过常规构建过程被编译成每个程序集的XML文档...
共享如何使用C#开发使用XML文件
最近做项目,要用C#写,而且数据格式是那种节点套节点能把人套死的XML,看着都觉得晕,而且节点跳跃性很大,真心觉得单纯用环境自带的XMLDocument类完全达不到自己的需要,因为XML里面涉及到节点循环,循环里面又套...
C# 提供一种机制,使程序员可以使用含有 XML 文本的特殊注释语法为他们的代码编写文档。在源代码文件中,具有某种格式的注释可用于指导某个工具根据这些注释和它们后面的源代码元素生成 XML。使用这类语法的注释称为...
C#语言写的,对xml文件进行读写,增删改查操作,每一步都有详细注释代码
主要包含一份VS工程,利用C#操作XML。代码里面有注释,详细的解释请看我的CSDN博客。非常适合新手学习。
C# XML文件读写操作源码,以及如何调用,注释详解,有任何问题请留言, 以下截取xml文件和部分调用代码段: * ++++++++++++++++++++++++++++++++++++++ <?xml version="1.0" encoding="utf-8" standalone="no"?&...
同一解决方案中一个项目的xml注释在另一个项目中不能智能提示显示这些注释的解决方法! 很值得下载看看!资源免费,大家分享!!
C#操作XML时,对xmlNode增、删、改操作
C# XML入门经典——C#编程人员必备的XML技能 作者:[美]Stewart Fraser, Steven 著,毛尧飞,崔伟 译 出版社:清华大学出版社 出版时间:2003年11月 第1章 在C#中使用XML的原因 <br>1.1 使用XML的原因...
使用原生的xml类实现增删改节点,读取xml结点,遍历,查找结点,修改结点属性 增删改查子结点,包括完整的代码及测试项目,关键位置均加了注释,是我学习了几天C#后自己写的学习与测试项目。 欢迎指正!
简单对XML文件的读写操作,代码里有详细的每一步的注释,一看就懂
在C/C++,JAVA中,有两种注释,一种是单行注释,即两根反斜杠(//),另一种是多行注释,即... 在C#中采用了另外一种形式,即XML。为了能够在编译过程中生成XML文档,需要一种来标记来标注注释。即三根反斜杠。下面是一个
XML ReadWrite经典实例,有注释. 用C#实现XML文件读写的示例,比较详尽,简单易懂,认真看两三分钟即可掌握如何创建一个较复杂的XML文档 供有需要的同学学习参考.
对无属性xml进行操作。注释完整,3种方式进行xml操作 项目中文件可以直接输入名称 .config配置文件路径,输入文件全路径。
很久以前做的批量翻译注释文件XML。请下拉窗口边缘,并设置AppID和PDK,如果没有,请到api.fanyi.baidu.com去申请,把目录或xml托入TextBox并翻译注释文件,仅供参考。