java 代码规范

java  代码规范

一、方法的规范

 

下面呈现一段代码：

    /**
     * 收集类的所有常量。
     * 
     * @param clazz - 收集目标
     * @param findAncestor - 是否查找父类
     * @param findInterfaces - 是否查找接口
     * 
     * @return {@link Map} 包含类的所有常量
     */
    public static Map<String, ?> getConstantFrom(Class<?> clazz, // NL
            boolean isFindAncestor, boolean isFindInterfaces) {

        HashMap<String, Object> map = new HashMap<String, Object>();

        if (findInterfaces) {
            for (Class<?> interfaceClass : clazz.getInterfaces()) {
                fillConstantFrom(interfaceClass, map);
            }
        }

        if (findAncestor) {
            Class<?> superClass = clazz;
            while (superClass != null) {
                fillConstantFrom(superClass, map);
                superClass = superClass.getSuperclass();
            }
        }

        fillConstantFrom(clazz, map);

        return map;
    }

 

值得学习的地方：

• 方法的命名，从class得到一个实例，非常的简单明了，而且参数的命名，读起来就知道参数是干什么的
• 方法的注释
• 方法体中代码的风格，一段一段的让人读起来非常轻松，一个if语句一个段