标签：style   color   io   os   使用   ar   java   for   strong   

Koala编码规范

1 前言

2 源文件

• 代码必须格式化
• 不能出现黄色提示
• 类、方法必须写注释
• 类和方法级的说明需要句号，参数和返回就不需要（示例如下表）
• 代码保持清洁（不能留用//注释的代码等）

示例
/**
 * 抽象实体类，可作为所有领域实体的基类。
 *
 * @author yang
 *
 */
@MappedSuperclass
public abstract class BaseEntity implements Entity {


/**
     * 获取仓储对象实例。如果尚未拥有仓储实例则通过InstanceFactory向IoC容器获取一个。
     * @return 仓储对象实例
     */
    public static EntityRepository getRepository() {
        if (repository == null) {
            repository =
 InstanceFactory.getInstance(EntityRepository.class);
        }
        return repository;
    }


}

3 命名规范

1. 项目模块 只能使用小写字母和中划线，以中划线分割单词 koala-security-core
2. 包 只能使用小写字母 org.openkoala.security.core.domain
3. 类 只能使用大小写字母，大驼峰式 EntityRepository.java
4. 字段 只能使用大小写字母和下划线，小驼峰式 private String userAccount
5. 方法 只能使用大小写字母，小驼峰式 findChildrenOfOrganization
6. URL 只能使用小写字母和中划线 employee/get-posts-by-employee.koala
7. JS、CSS、JSP 只能英文、数字和中划线 

4 模块约定

4.1领域层

4.2应用层

4.3门面层

4.4门面实现层

Koala编码规范

标签：style   color   io   os   使用   ar   java   for   strong   

原文地址：http://my.oschina.net/xiaokaceng/blog/325810