/// <summary> 函数说明 </summary>
/// <param name= "a"> 参数a </param>
/// <param name= "b"> 参数b</param>
/// <res> aaaaa </res>我在网上查的是在函数前加///,然后以XML格式指定需要添加的注释内容,我试了一下这样确实是有效果的.但我看了一下File.OpenRead这个函数的定义,它是在函数前用这样的方式注释的
// 摘要:
// 打开现有 UTF-8 编码文本文件以进行读取。
//
// 参数:
// path:
// 要打开以进行读取的文件。
//
// 返回结果:
// 指定路径上的 System.IO.StreamReader。
//
// 异常:
// System.UnauthorizedAccessException:
// 调用方没有所要求的权限。
// .......................
我用这种形式好像不行,但我在使用File.OpenRead的时候它确实是有说明,这种格式是什么呢.怎样使用?
另外还有一个问题就是.对于异常的注释部分,我必须一个一个全部自己写吗.
例如我在函数里面用了一个File.OpenRead函数,这个函数可能产生7,8个异常.然后又调用了其他函数,也有几个异常.那么我的函数可能产生的异常就是这些函数异常的和.
有没有办法让我的函数的异常注释部分自动加上我调用的其他函数的异常说明呢.还是我必须一个一个把这些函数里面的异常说明再照抄一遍??
/// <param name= "a"> 参数a </param>
/// <param name= "b"> 参数b</param>
/// <res> aaaaa </res>我在网上查的是在函数前加///,然后以XML格式指定需要添加的注释内容,我试了一下这样确实是有效果的.但我看了一下File.OpenRead这个函数的定义,它是在函数前用这样的方式注释的
// 摘要:
// 打开现有 UTF-8 编码文本文件以进行读取。
//
// 参数:
// path:
// 要打开以进行读取的文件。
//
// 返回结果:
// 指定路径上的 System.IO.StreamReader。
//
// 异常:
// System.UnauthorizedAccessException:
// 调用方没有所要求的权限。
// .......................
我用这种形式好像不行,但我在使用File.OpenRead的时候它确实是有说明,这种格式是什么呢.怎样使用?
另外还有一个问题就是.对于异常的注释部分,我必须一个一个全部自己写吗.
例如我在函数里面用了一个File.OpenRead函数,这个函数可能产生7,8个异常.然后又调用了其他函数,也有几个异常.那么我的函数可能产生的异常就是这些函数异常的和.
有没有办法让我的函数的异常注释部分自动加上我调用的其他函数的异常说明呢.还是我必须一个一个把这些函数里面的异常说明再照抄一遍??
解决方案 »
- 基于.net的windows服务中 如何让任务并行执行(基于.net 4.0 Task)
- 大家做客户端软件有没有会应用到用户行为分析的
- 关于Developer Express 组件的问题。
- 菜鸟问题
- C#程序里如何把多个dll,xml等整合进一个exe呢?打包部署我已经试过了,不符合要求,,求解
- 向高手请教,平面上不均匀散布一些点,如何求近似直线,谢谢!
- VS2005环境中的label控件问题?
- 一个关于联系人的问题???
- 调试时出现错误:未处理的“System.Runtime.Serialization.SerializationException”类型的异常出现在 mscorlib.dll 中
- c# serial port接收信息后转换格式再显示的问题
- 请问c#字符串 指针 int之间怎么转换啊
- winfrom 多线程调ACCESS数据库出现非首次调用异常
<example> 指定使用方法或其他库成员的示例<exception> 允许指定可能发生的异常类
<param> 描述一个参数
*DoIt函数注释
*/
DoIt(int a/*a变量*/,int b/*b变量*/);
这样估计也成吧.