关于方法定义的一些技巧

2009-11-17
    关于方法定义的一些技巧
      描述性的文字,这个方法是做什么的,如有分段可以用<p>来排版分段
      另:如果方法是健壮性的,即方法自己捕获可能的异常而不会抛出异常
         是一方面,但有时这样会导致调用者忽略一些可能出现的问题,所以
         也可以不做任何异常捕获,而明确提示调用者会出现哪些异常的
         可能,使其在上游调用时就做好各种异常的考虑.
      总之,关于异常要有一个明确的计划,是在底层分发,还是在某一层统一
          处理,这些是要在动手编码前做架构考虑的.
    /**
     * 这个方法是返回名字的大写内容
     * <p>
     * 只有参数名是字母才满足这个功能,其它则抛出异常
     * @param name 名称
     * @return 大写的名称
     * @exception IOException 如果无法访问时抛出这个异常
     * @exception NullPointerExcetion 如果name是空的
     */
    public String getValue(String name) throws IOException
    {
    }
    效果这样的:

这个方法是返回名字的大写内容
       
        只有参数名是字母才满足这个功能,其它则抛出异常
       
        Parameters:
        name 名称
        Returns:
        大写的名称
        Throws:
        IOException - 如果无法访问时抛出这个异常
        NullPointerExcetion - 如果name是空的