C#中的注释,一直没有搞懂,大家探讨一下

rui520_2002 2005-01-24 05:43:49
/// <summary>
/// 用gzip格式压缩指定的流,并返回压缩后的流
/// </summary>
/// <param name="uncompressedStream">要压缩的流</param>
/// <returns>用gzip格式压缩后的流</returns>
public static Stream Compress(Stream uncompressedStream) {
Stream compressedStream = new MemoryStream();
if(uncompressedStream == null || ! uncompressedStream.CanRead){
return compressedStream;
}
GZipOutputStream gzipOuput = new GZipOutputStream(compressedStream);
...
}
这种函数的注释是否有问题,为什么在同一个项目中能看到函数的参数及返回值的相关说明,在不同的项目中,或者编译成dll后,就没有了,翻了几次msdn,没有收获。
...全文
221 12 打赏 收藏 转发到动态 举报
写回复
用AI写文章
12 条回复
切换为时间正序
请发表友善的回复…
发表回复
muhan2008 2005-02-02
  • 打赏
  • 举报
回复
http://community.csdn.net/Expert/topic/3769/3769900.xml?temp=.1952173
Ivony 2005-02-02
  • 打赏
  • 举报
回复
一、生成XML注释文件。
二、令XML文件与程序集的名称一致。
三、将XML文件与DLL文件放到一起。
wgif_79 2005-02-02
  • 打赏
  • 举报
回复
vs环境有生成注释web页功能,可以生成个网站,实现多层的协同开发,当然前提是你的注释要比较全面,在工具菜单下。
sun926 2005-02-02
  • 打赏
  • 举报
回复
不过命名上应该有规范,只取程序集名称,比如a.dll的注释应该用a.xml
tiaoci 2005-02-02
  • 打赏
  • 举报
回复
too楼上,少见多怪了不是,

只要把生成的xml和dll一起发布到同一个目录

其它项目引用时就能看到详细文档说明了
EATSAHARA 2005-02-02
  • 打赏
  • 举报
回复
我晕,你当你发布的dll是个集成环境啊
rui520_2002 2005-02-02
  • 打赏
  • 举报
回复
这么长时间怎么没有人回贴???
其实我的问题就是如果要发布一个dll,怎么才能让用户在使用的过程中能够象使用.net的framework一样,有友好的提示。
rui520_2002 2005-01-24
  • 打赏
  • 举报
回复
to:whmjw
先谢了,:),但没有明白,设了“Xml文档文件”后,在生成时会生成注释的xml文件,可注释还是看不到,是否还要设置什么?
EATSAHARA 2005-01-24
  • 打赏
  • 举报
回复
http://www.cnblogs.com/bonny.wong/archive/2005/01/07/88283.aspx
minghui000 2005-01-24
  • 打赏
  • 举报
回复
up
兔子-顾问 2005-01-24
  • 打赏
  • 举报
回复
mark,learn
whmjw 2005-01-24
  • 打赏
  • 举报
回复
这是需要在某个项目中写入生成 的Xml文档的路径才行

点击某一个项目,按右键,点击属性,->配置属性->Xml文档文件,写下生成的文件就行了:)

111,119

社区成员

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

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

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