C#写好的类库dll怎么在别人调用的时候也能看到注释？

Question

rt

Answer 1

菜单 Project -> 'xxxx' Properties -> Build -> Output -> 勾上 XML Documentation file

Answer 2

我一般用的是在这个函数前面加这个：
/// <summary>
/// 测试函数
/// </summary>
/// <param name="obj1">参数1</param>
/// <param name="obj2">参数2</param>
/// <returns>返回值</returns>
public int TestFun(object obj1, object obj2)
{
    return 1;
}

Answer 3

写代码的时候先要在方法或属性前自己添加注释标记.如下:
        /// <summary>
        /// 
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>

Answer 4

当你发布成dll之后给别人调用就看不到了- -

Answer 5

利用XML注释。
如下：我一般用的是在这个函数前面加这个：
/// <summary>
/// 测试函数
/// </summary>
/// <param name="obj1">参数1</param>
/// <param name="obj2">参数2</param>
/// <returns>返回值</returns>
public int TestFun(object obj1, object obj2)
{
    return 1;
}

Answer 6

明白楼主的意思
我也是
在dll里面写上如下这样
// <summary>
/// 测试函数
/// </summary>
/// <param name="obj1">参数1</param>
/// <param name="obj2">参数2</param>
/// <returns>返回值</returns>
public int TestFun(object obj1, object obj2)
{
    return 1;
}
但是在别的地方调用好像显示不出来

Answer 7

1.项目的属性里面，要选上“生成XML注释文档”
2.生成时是生成dll和xml，别人要引用这个dll，把xml也烤给他，他就能看到dll的注释了。

Answer 8

按照一楼的做法，生成注释XML文件。
发布DLL的时候连同生成的XML注释文件一块发布，将注释文件放在和DLL同级目录下就可以了。

Answer 9

        ///  <summary>
        /// 
        ///  </summary>
        ///  <param name="sender"> </param>
        ///  <param name="e"> </param>
这个是最正宗的

Answer 10

这样生成XML文档有问题，不该公开的公开了：比如说，A类是我想公开的dll类，但是因为A类调用了B类，结果B类中的公开方法也生成到XML文件里了。

Answer 11

这个是正解。ls也太菜了。微软内部的规矩是连private级别的都要注释。

Answer 12

原来是先生成了XML文档以后,然后它自然就会与DLL的文件夹出现这时再引用那个DLL就会在写代码时看到相关的注释了,我的理解正确吗?(没有试过)

Answer 13

以前也尝试过编译后带注释的问题 学习了另借宝地问一问题:自己写的控件(dll类型的) 通过什么方式注册可以让它直接显示在工具栏里? 直接引用的方法我会 不过那样别人引用总是麻烦了一步 我是想通过将其发布为安装程序 安装后直接能看到

Answer 14

/// <summary>
/// 测试函数
/// </summary>
/// <param name="obj1">参数1</param>
/// <param name="obj2">参数2</param>
/// <returns>返回值</returns>
public int TestFun(object obj1, object obj2)
{
    return 1;
}
一般这样就可以了在调用的时候看到注释，如果你需要将函数说明等等这些注释在其他的文件中显示供用户查看就采用1楼的方式，会额外的生成一个xml文件的。

Answer 15

首先 你代码里要有注释  就是///那个.
其次 项目的属性里面，要选上“生成XML注释文档” 
最后 别人要引用这个dll，XML和DLL要一起COPY走。