C#一个简单的问题(关于注释提示) 各位大侠,我刚刚接触过C#,我有一个问题,我发现,MS的类库对于某一个类的某个方法,在我们使用时,都有中文提示的,例如,发我们写下Console.Write()时,它就会现“从标准字节流计取下一个字节”这样一个说明,如何在我们自定义的方法中也实现此说明呢?谢谢! 解决方案 » 免费领取超大流量手机卡,每月29元包185G流量+100分钟通话, 中国电信官方发货 写好方法声明后,在方法前加///然后在/// <summary>/// 这儿加注释/// </summary> /// <summary>/// 注释写在这里啊/// </summary>public void ConsoleOutput0(){ MessageBox.Show("ConsolwOutput0");}如上所述,在方法,属性,类上打///会自动生成格式的。 简介大多数程序员可能都听说过Java自带的一个工具JavaDoc;使用它可以自动地为你的代码生成HTML文档。C#和C#编译器也有类似的功能,不过它生成的是XML,而不是直接生成HTML。不过使用XML会使得文档更加灵活。注释语法 为了使用C#提供的XML注释功能,你的注释应该使用特殊的注释语法(///)开头。在///之后,你可以使用预先定义的标签注释你的代码,也可以插入你自己定义的标签。你定制的标签将会在随后加入到生成的注释文档中。预定义的标签 用处<c> 将说明中的文本标记为代码<code> 提供了一种将多行指示为代码的方法<example> 指定使用方法或其他库成员的示例<exception> 允许你指定可能发生的异常类<include> 允许你引用描述源代码中类型和成员的另一文件中的注释, 使用 XML XPath 语法来描述你的源代码中的类型和成员。<list> 向XML注释文档中插入一个列表<para> 向XML注释文档中插入一个段落<param> 描述一个参数<paramref> 提供了一种指示一个词为参数的方法<permission> 允许你将成员的访问许可加入到文档中<res> 用于添加有关某个类型的信息<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> IDE可以做的,在你的项目上单击右键-----》属性-----》配置属性-----》生成-------》输出------》XML 文档文件,然后你可以输入和你的项目同名的XML文件(也许可以不同名)。你就可以在bin目录或主程序所在目录下发现XML文件,调用时一起拷贝过去就可以了注释文件有命名规范:<程序集名称>.xml, 并且与程序集在同一个目录下。 我也遇到这种问题,不知是什么原因,但在本地调用都可以显示,打成DLL就没有显示了,请高手帮忙! [集思广益]C/S模式下权限控制 播放视频的com里的Window Media Player C#中webBrowser 第二次访问同一个地址,验证码不刷新的问题! 在C#中怎样调用ocx控件 TextBox 的绑定问题! 错误提示:"此文件是由另一个专案开启" 部署项目的高级问题,高手请进 wpf应用程序使用treeview绑定任意格式的xml文件 关于asp调用.net dll的问题 socket 异步接收的问题 用钩子碰到的一个问题。 .net中,如何给 “托盘程序” 发送消息呢?
///
然后在
/// <summary>
/// 这儿加注释
/// </summary>
/// 注释写在这里啊
/// </summary>
public void ConsoleOutput0()
{
MessageBox.Show("ConsolwOutput0");
}如上所述,在方法,属性,类上打///会自动生成格式的。
例子下面的例子为我们常见的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>
IDE可以做的,在你的项目上单击右键-----》属性-----》配置属性-----》生成-------》输出------》XML 文档文件,然后你可以输入和你的项目同名的XML文件(也许可以不同名)。你就可以在bin目录或主程序所在目录下发现XML文件,调用时一起拷贝过去就可以了
注释文件有命名规范:<程序集名称>.xml, 并且与程序集在同一个目录下。