开发指南
目录
开发规范
TOC
IDE配置和使用 Idea配置的两种生效方式 Copyright设置 文件头注释设置 文件编码设置 Lombok设置 git配置和使用 git全局配置 使用gitflow模式 提交及日志编写规范 开发规范Java开发过程中的总体规范及注意事项可参考阿里《Java开发手册》,文档下载(1.5.0华山版): Java规范 Javascript规范 数据库规范 API接口设计规范
IDE配置和使用Idea配置的两种生效方式Idea的配置生效方式有两种: For new projects 的配置对所有新创建的项目都会生效,如果是所有项目统一的配置在这里设置。如下图: For current projects 的配置只对当前打开的项目生效,如下图: Copyright设置公司项目统一使用如下模板 Copyright (c) $today.year. Foresee Science & Technology Ltd. 第一步:设置模板 第二步:应用设置 文件头注释设置Java文件在import语句之后添加,其它文件在Copyright注释之后添加,统一使用如下格式(注意修改作者和联系方式) /** * <pre> * $description * </pre> * * @author kevin [email?protected] * @version 1.0.0 * @date ${DATE} ${TIME} * * <pre> * 修改记录 * 修改后版本: * 修改人: * 修改日期: * 修改内容: * </pre> */ 文件编码设置工程编码和文件编码统一使用 Lombok设置工程中默认使用Lombok插件简化代码,使用前请做如下配置: 启用Annotation processing 启用Lombok git配置和使用git全局配置修改git全局配置文件中的如下部分,user部分配置提交时的名称和email,core部分主要为了解决不同操作系统协同时的换行符问题。 [user] name = 匡勇 email = [email?protected] [core] autocrlf = false safecrlf = true 使用gitflow模式
提交及日志编写规范(编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |