加入收藏 | 设为首页 | 会员中心 | 我要投稿 李大同 (https://www.lidatong.com.cn/)- 科技、建站、经验、云计算、5G、大数据,站长网!
当前位置: 首页 > 编程开发 > Java > 正文

开发指南

发布时间:2020-12-15 07:42:16 所属栏目:Java 来源:网络整理
导读:目录 开发规范 IDE配置和使用 Idea配置的两种生效方式 Copyright设置 文件头注释设置 文件编码设置 Lombok设置 git配置和使用 git全局配置 使用gitflow模式 提交及日志编写规范 TOC 开发规范 Java开发过程中的总体规范及注意事项可参考阿里《Java开发手册》

目录

开发规范
IDE配置和使用
Idea配置的两种生效方式
Copyright设置
文件头注释设置
文件编码设置
Lombok设置
git配置和使用
git全局配置
使用gitflow模式
提交及日志编写规范
TOC

开发规范

Java开发过程中的总体规范及注意事项可参考阿里《Java开发手册》,文档下载(1.5.0华山版):
https://102.alibaba.com/downloadFile.do?file=1561031481870/Java-huashanxinban.pdf
建议安装 Alibaba Java Coding Guidelines 插件对代码规范进行扫描检查。

Java规范
Java规范可参考公司前辈整理的相关文档:Java及Java EE编码规范.pdf

Javascript规范
Javascript规范可参考公司前辈整理的相关文档:JavaScript编码规范.pdf

数据库规范
数据库规范可参考公司前辈整理的相关文档:数据库编码规范.pdf

API接口设计规范
关于API的设计规范可以参考金财整理的《开放API规范》:
http://wiki.foresee.com.cn/wiki/pages/viewpage.action?pageId=21954564

上述规范均有公司编写好的文档供大家参考,请务必下载后认真研读,将文档中的规范落实在日后的开发过程中。

IDE配置和使用

Idea配置的两种生效方式

Idea的配置生效方式有两种:For new projectsFor current projects,配置时请注意。

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>
*/

文件编码设置

工程编码和文件编码统一使用UTF-8 NO BOM,如下图:

Lombok设置

工程中默认使用Lombok插件简化代码,使用前请做如下配置:
安装Lombok插件

启用Annotation processing

启用Lombok

git配置和使用

git全局配置

修改git全局配置文件中的如下部分,user部分配置提交时的名称和email,core部分主要为了解决不同操作系统协同时的换行符问题。
全局配置文件路径:%USERPROFILE%/.gitconfig,资源管理器中输入后打开。

[user]
    name = 匡勇
    email = [email?protected]
[core]
    autocrlf = false
    safecrlf = true

使用gitflow模式

  1. 开发过程中要严格按照gitflow的工作模式进行开发,开发人员不允许直接在master、develop等其它主要分支上进行开发。
  2. 远程仓库将master和develop分支设置为仅主程序员可推送,开发人员不可推送。
  3. 开发人员如果要往develop或master分支合并代码使用gitlab的merge request功能。

提交及日志编写规范

(编辑:李大同)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!

    推荐文章
      热点阅读