Làm thế nào để ghi lại các ngoại lệ được ném trong c # /. Net

Tôi hiện đang viết một khung nhỏ sẽ được sử dụng nội bộ bởi các nhà phát triển khác trong công ty.

Tôi muốn cung cấp thông tin Intellisense tốt, nhưng tôi không chắc làm thế nào để ghi lại các trường hợp ngoại lệ.

Trong ví dụ sau:

public void MyMethod1()
{
    MyMethod2();

    // also may throw InvalidOperationException
}

public void MyMethod2()
{
    System.IO.File.Open(somepath...); // this may throw FileNotFoundException

    // also may throw DivideByZeroException
}

Tôi biết đánh dấu cho các tài liệu ngoại lệ là:

/// <exception cref="SomeException">when things go wrong.</exception>

Điều tôi không hiểu là làm thế nào để ghi lại các trường hợp ngoại lệ được ném bởi mã được gọi bởi MyMethod1() ?

• Tôi có nên ghi lại các trường hợp ngoại lệ MyMethod2()
• Tôi có nên ghi lại các trường hợp ngoại lệ File.Open()?

Điều gì sẽ là cách tốt nhất để ghi lại các trường hợp ngoại lệ có thể?

Bạn nên ghi lại mọi ngoại lệ có thể được ném bởi mã của bạn, bao gồm cả các ngoại lệ trong bất kỳ phương thức nào bạn có thể gọi.

Nếu danh sách trở nên hơi lớn, bạn có thể muốn tạo loại ngoại lệ của riêng mình. Nắm bắt tất cả những gì bạn có thể gặp trong phương pháp của bạn, bọc chúng trong ngoại lệ của bạn và ném nó.

Một nơi khác mà bạn có thể muốn làm theo cách này là nếu phương thức của bạn nằm trên mặt API của bạn. Giống như mặt tiền đơn giản hóa nhiều giao diện thành một giao diện, API của bạn sẽ đơn giản hóa nhiều ngoại lệ thành một ngoại lệ duy nhất. Làm cho việc sử dụng mã của bạn dễ dàng hơn cho người gọi.

Để trả lời một số mối quan tâm của Andrew (từ các bình luận), có ba loại ngoại lệ: Những người bạn không biết, những người bạn biết và không thể làm gì, và những gì bạn biết và có thể làm gì đó.

Những người bạn không biết về bạn muốn cho đi. Đó là nguyên nhân của sự thất bại nhanh chóng - tốt hơn là ứng dụng của bạn gặp sự cố hơn là vào trạng thái mà bạn có thể sẽ làm hỏng dữ liệu của mình. Sự cố sẽ cho bạn biết về những gì đã xảy ra và tại sao, điều này có thể giúp loại bỏ ngoại lệ đó ra khỏi danh sách "những điều bạn không biết về".

Những cái bạn biết và không thể làm gì là những ngoại lệ như OutOfMemoryExceptions. Trong trường hợp cực đoan, bạn có thể muốn xử lý các trường hợp ngoại lệ như thế này, nhưng trừ khi bạn có một số yêu cầu khá đáng chú ý, bạn coi chúng như thể loại đầu tiên - hãy đi. Bạn có phải ghi lại những trường hợp ngoại lệ này? Bạn sẽ trông khá ngu ngốc khi ghi lại các OOM trên mỗi phương thức mới tạo ra một đối tượng.

Những cái bạn biết và có thể làm một cái gì đó là những cái bạn nên ghi chép và gói lại.

Bạn có thể tìm thấy một số hướng dẫn thêm về xử lý ngoại lệ ở đây.

Bạn nên sử dụng tài liệu xml tiêu chuẩn .

/// <exception cref="InvalidOperationException">Why it's thrown.</exception>
/// <exception cref="FileNotFoundException">Why it's thrown.</exception>
/// <exception cref="DivideByZeroException">Why it's thrown.</exception>
public void MyMethod1()
{
    MyMethod2();
    // ... other stuff here
}

/// <exception cref="FileNotFoundException">Why it's thrown.</exception>
/// <exception cref="DivideByZeroException">Why it's thrown.</exception>
public void MyMethod2()
{
    System.IO.File.Open(somepath...);
}

/// <exception cref="FileNotFoundException">Why it's thrown.</exception>
public void MyMethod3()
{
    try
    {
        MyMethod2();
    }
    catch (DivideByZeroException ex)
    {
        Trace.Warning("We tried to divide by zero, but we can continue.");
    }
}

Giá trị khi thực hiện theo cách này là bạn đang cung cấp tài liệu về các ngoại lệ đã biết có thể xảy ra. Tài liệu này có sẵn trong intellisense nếu bạn đang sử dụng phòng thu trực quan và có thể nhắc nhở bạn (hoặc những người khác) sau về các trường hợp ngoại lệ mà bạn có thể mong đợi.

Bạn muốn chỉ định các loại ngoại lệ cụ thể, bởi vì bạn có thể xử lý một loại ngoại lệ, trong khi các loại khác là kết quả của một vấn đề nghiêm trọng và không thể sửa được.

Bạn có thể làm cho quy trình tài liệu của mình dễ dàng hơn bằng cách sử dụng một số bổ trợ tuyệt vời. Một trong số đó là GhostDoc , một bổ trợ miễn phí cho Visual Studio, tạo ra các bình luận XML-doc. Ngoài ra, nếu bạn sử dụng ReSharper , hãy xem Plugin Agent Johnson tuyệt vời cho ReSharper, bổ sung một tùy chọn để tạo nhận xét XML cho các ngoại lệ bị ném.

Cập nhật: Có vẻ như Agen Johnson không có sẵn cho R # 8, thanh toán Đặc biệt cho ReSharper như một thay thế ...

Bước 1: GhostDoc tạo nhận xét XML (Ctrl-Shift-D), trong khi plugin Agent Johnson cho ReSharper cũng đề xuất ghi lại ngoại lệ:

Bước 2: Sử dụng phím tắt của ReSharper (Alt-Enter) để thêm tài liệu ngoại lệ:

bước 2 http://i41.tinypic.com/osdhm

Mong rằng sẽ giúp :)

Theo những gì tôi hiểu, ý định sử dụng phần tử <ngoại lệ> là sử dụng nó khi phương thức trang trí, không phải là ngoại lệ:

/// <summary>Does something!</summary>
/// <exception cref="DidNothingException">Thrown if nothing is actually done.</exception>
public void DoSomething()
{
// There be logic here
}

Các ngoại lệ có thể được ném bởi các phương thức khác được gọi nên được bắt, xử lý và ghi lại trong các phương thức đó. Các ngoại lệ có thể có thể được ném bởi .NET hoặc các ngoại lệ được ném rõ ràng bằng mã của riêng bạn nên được ghi lại.

Theo như có bất kỳ cụ thể hơn thế, có lẽ bạn có thể nắm bắt và ném ngoại lệ tùy chỉnh của riêng bạn?

Một phần của hợp đồng cho phương pháp của bạn nên kiểm tra xem các điều kiện trước có hợp lệ không, vì vậy:

public void MyMethod2()
{
    System.IO.File.Open(somepath...); // this may throw FileNotFoundException
}

trở thành

/// <exception cref="FileNotFoundException">Thrown when somepath isn't a real file.</exception>
public void MyMethod2()
{
    FileInfo fi = new FileInfo( somepath );
    if( !fi.Exists )
    {
        throw new FileNotFoundException("somepath doesn't exists")
    }
    // Maybe go on to check you have permissions to read from it.

    System.IO.File.Open(somepath...); // this may still throw FileNotFoundException though
}

Với phương pháp này, việc ghi lại tất cả các trường hợp ngoại lệ mà bạn ném một cách rõ ràng mà không cần phải ghi lại rằng OutOfMemoryException có thể bị ném, v.v.

Bạn nên ghi lại tất cả các trường hợp ngoại lệ có thể được ném bằng phương pháp của bạn.

Để ẩn chi tiết triển khai, tôi sẽ cố gắng tự xử lý một số ngoại lệ từ MyMethod2.

Bạn có thể xem xét việc gửi lại chúng, nếu bạn không thể xử lý hoặc giải quyết ngoại lệ. Chủ yếu được đóng gói / bọc trong một ngoại lệ có ý nghĩa hơn cho người gọi.

Thật vậy, như đã được trả lời, cách để ghi lại các trường hợp ngoại lệ là sử dụng Nhận xét XML.

Ngoài các plugin, bạn cũng có thể sử dụng các công cụ phân tích tĩnh có thể được tích hợp với TFS để đảm bảo bạn có các ngoại lệ được ghi lại.

Trong các liên kết bên dưới, bạn có thể thấy cách xây dựng quy tắc tùy chỉnh cho StyleCop để xác thực các ngoại lệ được ném bởi các phương thức của bạn đang được ghi lại.

http://www.josefcobonnin.com/post/2009/01/11/Xml-Documentation-Comments-Exceptions-I.aspx http://www.josefcobonnin.com/post/2009/01/15/Xml-Documentation -Comments-Exceptions-II.aspx

Trân trọng.

Tài liệu ngoại lệ dự kiến ​​trong phương thức của bạn, trong ví dụ của bạn tôi sẽ cho người dùng biết rằng phương pháp đó có thể ném một tệp không tìm thấy ngoại lệ.

Hãy nhớ rằng đó là thông báo cho người gọi về những gì mong đợi để họ có thể chọn cách đối phó với nó.