Question

c#类库怎么显示注释

写好的类库在其他程序引用后怎么显示注释。

我从网上也找了一些资料，可以生成一个xml文件。
但是可不可以不要xml文件也可以有注释显示啊。

Answer 1

在写类的时候在方法加上///(3个斜杆)后再写注解,调用的时候是可以看到注释的。
当生成类库的时候，调用的时候是无法看法注释的。因为编译时，编译器是不会将源文件中的注释写入类库中的

C#中新建的类库添加注释时，应注意以下问题：
1、编译动态类库时命名空间要规范，一般不要和类同名，命名空间一般定义格式：项目名+类文件名；
2、动态类库中，类、方法的注释都采用下列方式注释：
类注释的格式：
/// <summary>
/// 文件名:Ini处理类/
/// 文件功能描述:读写Ini文件/
/// 版权所有:Copyright (C) ZGM/
/// 创建标识:2011.12.13/
/// 修改标识:/
/// 修改描述:/
/// </summary>
方法注释的格式：
/// <summary>
/// 读出Ini文件
/// </summary>
/// <param name="Section">Ini文件中的段落名称</param>
/// <param name="Key">Ini文件中的关键字</param>
/// <param name="IniFilePath">Ini文件的完整路径和名称</param>
/// <returns>Ini文件中关键字的数值</returns>
3、生成与动态类库相同名称的xml文件，具体设置是：项目右键—>属性—>生成—>XML文档文件选中再编译
4、引用动态类库时，把类库和同名的xml文件放到同一个文件夹内即可。

Answer 2

与类库对应的xml文件用于VS编程时的智能提示。
查看类库成员时，无法显示注释的。因为编译时，编译器是不会将源文件中的注释写入类库中的。

追问

那有没有什么方法可以即有注释，还不用xml文件。

追答

这个没有啊

追问

那微软自己的类库怎么就没有xml文件啊。

追答

有啊，见图

Answer 3

在你的方法名,类名,属性名等上面一行打///然后会自动生成一段代码,然后填内容就行了.
就像这样
/// <summary>
///MethodA 的测试
///</summary>
public void MethodATest()
{}