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

破碎的脸 2008-05-26 02:37:22
rt
...全文
1578 30 打赏 收藏 转发到动态 举报
写回复
用AI写文章
30 条回复
切换为时间正序
请发表友善的回复…
发表回复
liuzhenpolestar 2012-10-06
  • 打赏
  • 举报
回复
呼呼 学习了
楼上的帖子对俺很有帮助啊
fengyecsdn 2008-05-27
  • 打赏
  • 举报
回复
首先 你代码里要有注释 就是///那个.
其次 项目的属性里面,要选上“生成XML注释文档”
最后 别人要引用这个dll,XML和DLL要一起COPY走。
xiaomatian 2008-05-27
  • 打赏
  • 举报
回复
/// <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文件的。
醉龍 2008-05-27
  • 打赏
  • 举报
回复
哈哈哈哈哈
conan304 2008-05-27
  • 打赏
  • 举报
回复
学习学习
changweishao 2008-05-27
  • 打赏
  • 举报
回复
哦,学习了
南山五味子 2008-05-27
  • 打赏
  • 举报
回复
混淆一下,就可以了
地下室小红叔 2008-05-27
  • 打赏
  • 举报
回复
以前也尝试过编译后带注释的问题 学习了

另借宝地问一问题:自己写的控件(dll类型的) 通过什么方式注册可以让它直接显示在工具栏里? 直接引用的方法我会 不过那样别人引用总是麻烦了一步 我是想通过将其发布为安装程序 安装后直接能看到
ProjectDD 2008-05-27
  • 打赏
  • 举报
回复
原来是先生成了XML文档以后,然后它自然就会与DLL的文件夹出现

这时再引用那个DLL就会在写代码时看到相关的注释了,我的理解正确吗?(没有试过)
破碎的脸 2008-05-27
  • 打赏
  • 举报
回复
分不多,给第一个正确回答和第一个详细解答的朋友了。结贴!
zzyhuian06142 2008-05-26
  • 打赏
  • 举报
回复
在写类的时候在方法加上///(3个斜杆)如然后再写注解,调用的时候也可以看到啊
江城老温 2008-05-26
  • 打赏
  • 举报
回复
写代码的时候先要在方法或属性前自己添加注释标记.如下:
/// <summary>
///
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
Tll_W 2008-05-26
  • 打赏
  • 举报
回复
[Quote=引用 1 楼 smallfz 的回复:]
菜单 Project -> 'xxxx' Properties -> Build -> Output -> 勾上 XML Documentation file
[/Quote]
[Code=C#]
我一般用的是在这个函数前面加这个:
/// <summary>
/// 测试函数
/// </summary>
/// <param name="obj1">参数1</param>
/// <param name="obj2">参数2</param>
/// <returns>返回值</returns>
public int TestFun(object obj1, object obj2)
{
return 1;
}
[/Code]
wzjpsq 2008-05-26
  • 打赏
  • 举报
回复
才知道可以这样
BIGBIRDINWOODS 2008-05-26
  • 打赏
  • 举报
回复
嗯,才知道
wenjunliao 2008-05-26
  • 打赏
  • 举报
回复
编译之前代码写上注释,调用的时候就可以有注释了
smallfz 2008-05-26
  • 打赏
  • 举报
回复
菜单 Project -> 'xxxx' Properties -> Build -> Output -> 勾上 XML Documentation file
lextm 2008-05-26
  • 打赏
  • 举报
回复
[Quote=引用 14 楼 Choi57671452 的回复:]
1.项目的属性里面,要选上“生成XML注释文档”
2.生成时是生成dll和xml,别人要引用这个dll,把xml也烤给他,他就能看到dll的注释了。
[/Quote]
这个是正解。

ls也太菜了。微软内部的规矩是连private级别的都要注释。
BIGBIRDINWOODS 2008-05-26
  • 打赏
  • 举报
回复
这样生成XML文档有问题,不该公开的公开了:比如说,A类是我想公开的dll类,但是因为A类调用了B类,结果B类中的公开方法也生成到XML文件里了。
virusswb 2008-05-26
  • 打赏
  • 举报
回复
  ///  <summary>
///
/// </summary>
/// <param name="sender"> </param>
/// <param name="e"> </param>

这个是最正宗的
加载更多回复(9)

110,534

社区成员

发帖
与我相关
我的任务
社区描述
.NET技术 C#
社区管理员
  • C#
  • Web++
  • by_封爱
加入社区
  • 近7日
  • 近30日
  • 至今
社区公告

让您成为最强悍的C#开发者

试试用AI创作助手写篇文章吧