当前位置 : 主页 > 网页制作 > xml >

XML- C#的多个异常的文档

来源:互联网 收集:自由互联 发布时间:2021-06-13
我实际上是在搜索guidline,如何在C#-DLL中的公共方法中记录多个异常. 例: /// summary/// This method does something/// /summary/// param name="p_Parameter1"First parameter/param/// param name="p_Parameter2"Second param
我实际上是在搜索guidline,如何在C#-DLL中的公共方法中记录多个异常.

例:

/// <summary>
/// This method does something
/// </summary>
/// <param name="p_Parameter1">First parameter</param>
/// <param name="p_Parameter2">Second parameter</param>
/// <param name="p_Number">A number</param>
/// <exception cref="ArgumentNullException">
/// Thrown if p_Parameter1 is null</exception>
/// <exception cref="ArgumentNullException">
/// Thrown if p_Parameter2 is null</exception>
/// <exception cref="ArgumentNullException">
/// Thrown if any element of p_Parameter2 is null</exception>
/// <exception cref="ArgumentOutOfRangeException">
/// Thrown if p_Number is below or equal 0</exception>
/// <returns>A object</returns>
public static object DoSomething(
    object p_Parameter1, IList<object> p_Parameter2, 
    object p_Parameter3, int p_Number)
{
    if(p_Parameter1 == null)
        throw new ArgumentNullException(
            paramName:"p_Parameter1", 
            message:"Parameter is needed");
    if (p_Parameter2 == null)
        throw new ArgumentNullException(
            paramName: "p_Parameter2", 
            message: "Parameter is needed");

    for (int i = 0; i < p_Parameter2.Count; i++)
    {
        if(p_Parameter2[i] == null)
            throw new ArgumentNullException(
                paramName: String.Format("p_Parameter2[{0}]", i),
                message: "All elements have to be initialized");
    }

    if(p_Number < 0)
        throw new ArgumentOutOfRangeException(
            paramName: "p_Number", 
            message: "Parameter should be bigger then zero");

    var returnValue = new object();

    // do something where p_Parameter3 == null is allowed

    return returnValue;
}

这是记录这些例外的正确方法吗?我应该为每种情况添加一个异常标记,还是应该只为所有不允许空值的参数添加一个?

/// <exception cref="ArgumentNullException">
/// Thrown if p_Parameter1, p_Parameter2
/// or any element of p_Parameter2 are null</exception>
我肯定会按类型对异常进行分组,即抛出p_Parameter1,p_Parameter2
或者p_Parameter2的任何元素都是null.

作为参考,请查看MSDN上的文档.一个example:

ArgumentNullException   |   Either path, contents, or encoding is null.
网友评论