Effective Java读书笔记（第7章-方法）

     第7章  方法

     第38条：检查参数的有效性

     绝大多数方法和构造器对于传递给它们的参数值都会有某些限制，应该在文档中清楚地指明所有这些限制，并且在方法体的开头处检查参数，以强制施加这些限制。应该在发生错误之后尽快检测出错误。

     对于公有的方法，要用Javadoc的@throws标签在文档中说明违反参数值限制时会抛出的异常。如下例子：

/**
	 * 
	 * @param m the modulus, which must be positive
	 * @return this mod m
	 * @throws ArithmeticException if m is less than or equal to 0
	 */
	public BigInteger mod(BigInteger m){
		if(m.signum() <= 0){
			throw new ArithmeticException("Modulus <= 0:" + m);
		}
		return null;
	}

     
     对于未被导出的方法，可以使用断言来检查它们的参数。

private static void sort(long a[], int offset, int length){
		assert a != null;
		assert offset >= 0 && offset <= a.length;
		assert length >= 0 && length <= a.length - offset;
	}

     这些断言的条件将会为真，断言失败，将会抛出AssertionError。在eclipse中启动断言，可以在Run ---> Run Configurations ---> 选择 Arguments 选项卡在 VM arguments 文本框中输入: -ea。

     第39条：必要时进行保护性拷贝

    

     第40条：谨慎设计方法签名

     第41条：慎用重载

     第42条：慎用可变参数

     第43条：返回零长度的数组或者集合，而不是null

     第44条：为所有导出的API元素编写文档注释