C#中的注释,一直没有搞懂,大家探讨一下
/// <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,没有收获。