编写高质量代码改善C#程序的157个建议——建议153:若抛出异常,则必须要注释

建议153:若抛出异常,则必须要注释

有一种必须加注释的场景,即使异常。如果API抛出异常,则必须给出注释。调用者必须通过注释才能知道如何处理那些专有的异常。通常,即便良好的命名也不可能告诉我们方法会抛出那些异常,在这种情况下,使用注释是最好的手段。

        /// <summary>
/// 注释
/// </summary>
/// <param name="value">输入参数注释</param>
/// <returns>返回值注释</returns>
/// <exception cref="System.IO.IOException">如果……,则抛出IOException</exception>
public string SampleMethod(int value)
{
if (true)
{
throw new IOException("一些IO异常");
}
//省略
}

转自:《编写高质量代码改善C#程序的157个建议》陆敏技

上一篇:Android Studio中使用android:src="@drawable/ic_launcher"报错


下一篇:HDU 5280 Senior's Array 最大区间和