Virtual Campus

git 使用方法

安装 & 配置教程 github help

这里有一篇关于如何使用 github 的教程 GotGitHub 其中第 4.2 共享版本库 基本就是我们需要使用的模式。

  • git使用一般流程
git clone https://github.com/xindervella/VirtualCampus

	将远程 repo 代码 clone 至本地,只需在首次本地还没有 repo 的时候使用。

修改 & 添加代码

git add .

git pull

	在协作开发时在 commit 前要先将远程 repo 中代码 pull 回来检查是否冲突

git commit -m "注释"

git push

  • 其他常用 git 命令
全局变量初始化:

git config --global user.name "xindervella"

git config --global user.email "xindervella@gmail.com"
撤销修改:

1. 撤销尚未提交的修改:

git checkout head <文件名> 或 .

2. 撤销提交:

git rest head >文件名>	取消暂存

git rest --head head^  不会在 repo 中留下痕迹

分支:

1. 创建分支:

git brach <分支名>

2. 合并分支:

git merge <分支名>

3. 删除分支:

git brach -d <分支名> 如果分支没被合并删除失败

git brach -D <分支名> 如果分支没被合并照删不误
解决冲突:

1. 冲突较少时直接编辑有冲突文件提交即可

2. 冲突较复杂时使用 git merge tool

.gitignore 里为不需要同步至 repo 的配置文件,可以自己手动添加不想同步的文件。

===

基本命名规范

  • 避免难懂的名称,如xxK8

  • 类命名使用Pascal大小写处理 (CalculateInvoiceTotal),其中每个单词的第一个字母都是大写的。

  • 函数 & 变量命名,使用camel大小写处理 (documentFormatType),其中除了第一个单词外每个单词的第一个字母都是大写的。构造函数命名与类命名相同。

  • 常量命名,不要使用原义数字或原义字符串,而是使用命名常数(MAX_VALUE) ,以便于维护和理解。

代码书写规范

尤其是谈小伟请注意再密密麻麻写一起就干死你

  • 在括号对齐方式使用以下两种均可
for(i=0; i<100; i++){

	// code block

}

for(i=0; i<100; i++)
{

	// code block

}
  • 沿逻辑结构行缩进
if(expression){
	if(expression){

		// code block

	} else {

		// code block

	}
}
  • SQL语句关键字全部使用大写
SELECT * FROM Table1 WHERE State = 'WA';

注释规范

所有Java代码,请至少在编写时写明以下注释

  • 某个类之前
/**
 * 类的简单介绍
 * @author      类作者
 */
public class Test {

	// class body

}
  • 某个方法(函数)前:
/**
 * 函数功能介绍
 * @param  传入参数
 * @return  返回值
 */
public void test(){

	// function body

}

具体参照 javadoc

===

server 端数据库目前使用 mysql 如需使用需要自己添加依赖包

数据表名为 holyshit

数据库登陆用户名为 root

数据库登陆密码为 123212321

CREATE  TABLE `holyshit`.`user` (

  `sID` INT NOT NULL ,

  `password` VARCHAR(45) NOT NULL ,

  `type` INT NOT NULL COMMENT 'USER_TYPE:1:STUDENT;2:TEACHER;3:OTHER' ,

  `name` VARCHAR(45) NOT NULL ,

  PRIMARY KEY (`sID`) ,

  UNIQUE INDEX `sID_UNIQUE` (`sID` ASC) )

DEFAULT CHARACTER SET = utf8;

测试数据需自己添加