JSMSoft软件代码分布式版本控制系统单机版.docx
- 文档编号:23694625
- 上传时间:2023-05-20
- 格式:DOCX
- 页数:38
- 大小:1.48MB
JSMSoft软件代码分布式版本控制系统单机版.docx
《JSMSoft软件代码分布式版本控制系统单机版.docx》由会员分享,可在线阅读,更多相关《JSMSoft软件代码分布式版本控制系统单机版.docx(38页珍藏版)》请在冰豆网上搜索。
JSMSoft软件代码分布式版本控制系统单机版
JSMSoft分布式版本控制系统
(单机版)
用户手册
V1.0
杰思敏(上海)信息科技有限公司
2013年8月
第一章系统概述
JSMSoft是一套分布式的版本控制系统,运用C#语言开发。
它类似Git提供代码历史版本保存、对比、下载、需求和BUG管理等功能。
用户可拥有个人库,可以单机自成体系地运行。
内置JSMMerge三方对比合并工具和JSMCompare比较文件和文件夹的工具。
是JSM软件研发管理平台中的一个重要的管理系统。
JSMSoft可独立地应用于个人独立开发或小组开发,它可以控制任何文件的版本、实现分支和归并功能、进行文本比较、标记注释和版本报告信息。
JSMSoft还可以作为JSM平台的客户端程序,管理本地代码,具备提交测试、审核等协同功能。
采用JSMClient的好处是:
只需要当完成某个需求和解决某个BUG时,保存一下项目就行了。
其它事情,由JSM系统去处理。
把每个小阶段的成果都保存起来。
JSM操作简单,易学易用,能做到无师自通。
同时功能十分强大。
1.1.系统功能简介
JSM=Jasmine
JSM=JasmineSoftwareManagement
JSM=杰(Jie)思(Si)敏(Min)
JSMSoft版本控制系统供如下功能:
1.管理本地代码;
2.可与VS开发工具集成;
3.保持项目代码的历史版本;
4.查看项目代码的历史版本;
5.下载项目代码的历史版本;
6.项目代码的需求和BUG管理。
JSM着力解决软件研发中的问题:
1.现场开发:
我们经常需要将代码带到客户现场开发,这样,很难对在客户现场的开发过程进行有效地管理,为此,就需要一套分布式版本控制系统。
2.新员工培训:
新入职的员工,如何通过阅读代码,快速提高业务能力?
3.新加入项目的员工:
如何快速了解项目进展状况,迅速进入角色?
4.代码注释:
需要程序员规范地书写,但往往程序员编写不规范,表达不清晰,反而造成维护、阅读困难。
程序员能不能少写甚至不写注释,程序只保留漂亮的、干净的代码?
5.需求、BUG:
修改后,准确地哪些代码改动了,发现类似的问题,想方便地查出来以前是如何改的?
"还有件事情,有一次你修改了一个Bug,后来你再次碰到一个类似的Bug,虽然你找到了当初修改的那个Bug描述,但是你却还是不知道当初怎么修改的,所以呢,再次吭哧吭哧去翻代码,浪费大量时间,也许你终于找到那块代码,但是却发现这块代码后来被改过好几次了,也就是有N多个版本了,你不知道哪一个版本是你改的,头疼啊,还是再研究研究......"
6.软件重构:
根据重构的需要,有些模块需要搬迁到新的文件中,有些文件需要新命名/重名名。
而在有些版本控制工具中,如SVN,重命名一个文件,它是当作删除然后添加过来处理的。
这样一来,新的文件将会有新的历史,而原来的历史,已随老的文件烟消云散。
也许,从版本控制中还能找回被删除的老的文件。
但如果作为一个新接触的员工,对于将重命名分解为删除和添加的操作而言,谁又知道以前被删除的文件是哪一个?
时间长了,老员工也记不住啊!
7.定制开发:
每一个客户都可能要求修改或添加一些功能,甚至有些功能是该客户单独有的,这样公司在代码管理这一块就遇到麻烦了,如果只保留一套代码的话,那么软件会越来越大,有时修改了功能甚至会导致软件有些不稳定,而且如果一个客户用了一年以后发现有一个问题,而且必须修改程序才能处理,在这一年期间里公司的软件已经更新了很多功能,这样不处理客户的问题肯定是不行,要处理的话就必须升级到最新的程序,非常麻烦;如果公司保留一套标准版,并且为单独保留每一个客户的代码的话,这样一来代码非常多,管理起来非常麻烦,二来如果给A客户添加了的功能,B客户也要使用到时就必须修改两次代码,也非常麻烦。
8.自动同步:
能不能自动同步程序、数据?
白天在公司用台式机编写程序,晚上用笔记本带回去工作,往往,不是忘记拷贝这个程序就是忘了同步那个数据,回去后还是干不了活。
每天都花时间和精力做同步工作。
9.工作流程:
将软件开发、测试、文档编制、发布、维护过程通过工作流程管理起来,使每项工作都很清晰。
10.权限管理:
更方便、更细致的权限管理。
11.符合标准:
在电子行业,如何将软件代码控制与产品版本控制(PLM系统)结合起来,对产品库、受控库、开发库进行有效地管理?
12.安全措施:
需要更多的安全管理措施来管理,如三员管理。
第二章界面介绍
2.
2.1.主界面展示
图2-1JSM软件项目管理主界面
如图2-1,JSM软件项目管理主界面由七部分组成:
1)菜单栏
2)工具栏
3)当前项目栏
4)历史版本栏
5)状态栏
2.2.菜单栏
如图2-2,菜单栏由两部分组成:
图2-2JSM软件项目管理菜单栏显示
1.
2.
2.1.
2.2.
2.2.1.文件菜单
如图2-3,文件菜单:
图2-3JSM软件项目管理文件菜单
如表2-1,文件菜单栏功能显示:
文件
保存项目(P)
保存当前项目
保存文件(S)
保存当前文件
导入项目
导入新的项目版本
导入文件
导入新的项目文件
项目属性(A)
打开项目属性信息
退出(Exit)
退出JSM软件项目管理系统
表2-1JSM软件项目管理文件菜单功能表
2.2.2.需求菜单
如图2-4,需求菜单:
图2-4JSM软件项目管理需求菜单显示
如表2-2,需求菜单栏功能显示:
需求
需求管理:
进入需求与BUG管理界面
表2-2JSM软件项目管理需求菜单功能表
2.2.3.BUG
如图2-5,BUG菜单:
图2-5JSM软件项目管理BUG菜单显示
如表2-3,BUG菜单栏功能显示:
BUG
BUG管理:
进入需求与BUG管理界面
表2-3JSM软件项目管理BUG菜单功能表
2.2.4.选项菜单
如图2-6,选项菜单:
图2-6JSM软件项目管理选项菜单显示
如表2-4,选项菜单栏功能显示:
选项
JSM对比
对比工具,默认勾选JSM对比
表2-4JSM软件项目管理选项菜单功能表
2.2.5.设置菜单
如图2-7,设置菜单
图2-7JSM软件项目管理设置菜单显示
如表2-5,设置菜单栏功能显示:
设置
设置第三方对比工具
在这里设置第三方对比工具
隐藏相同的文件
隐藏无需对比的文件
查看所有同名的文件
只显示同名文件
查看删除的目录和文件
查看删除的目录和文件
恢复出厂设置
还原用户设置
表2-5JSM软件项目管理选项菜单功能表
2.2.6.帮助菜单
如图2-8,帮助菜单:
图2-8JSM软件项目管理帮助菜单显示
如表2-6帮助菜单功能介绍:
帮助
查看帮助
JSM软件项目管理的介绍和使用说明
注册产品(p)
注册产品
检查软件新版本
检查是否有新版发布,并升级
访问杰思敏网站
访问杰思敏网站
给作者写信
给作者发邮箱信息
关于MJC软件代码管理(A)
JSM软件项目管理的基本信息介绍
表2-6JSM软件项目管理帮助菜单功能表
2.3.工具栏
如图2-9,JSM软件项目管理工具栏展示:
图2-9JSM软件项目管理工具栏显示
如表2-7,工具栏有以下九大功能:
工
具
栏
保存项目
保存选中的项目生成新版本
保存文件
保存选中的文件生成新版本
导入项目
导入新的项目版本
导入文件
导入新的项目文件
与最新版本对比
将当前项目代码与最新版本对比
与最老版本对比
将当前项目代码与最老版本对比
与其它历史版本对比
将当前项目代码与其他历史版本对比
隐藏相同
隐藏相同的文件
查看同名
查看同名的文件
图2-7JSM软件项目管理工具栏功能表
2.4.当前项目栏
当前项目栏用于显示当前项目的保存路径和属性信息。
并提供了方便的右键菜单的操作,方便用户了解当前项目的信息和对当前项目的对比和更改保存等操作。
2.4.1.显示当前项目路径
如图2-10,该栏中当前项目路径显示当前项目的保存路径。
图2-10当前项目路径
1.
2.
2.1.
2.2.
2.3.
2.4.
2.4.1.
2.4.2.当前项目树结构
如图2-11,框体中项目以结构树清晰的呈现出各条目层级关系和属性关系。
图2-11当前项目树结构显示
2.5.历史版本栏
如图2-12,历史版本栏由三部分组成:
1.项目信息显示栏
2.项目内容编辑栏
3.需求与BUG显示栏
图2-12历史版本栏显示
2.5.1.项目信息显示栏
如图2-12,当点击左栏中的当前项目或项目文件时,对应保存的项目或项目文件的历史版信息会在历史版本信息中显示出来,用户可以使用右键菜单的功能对项目进行操作,具体操作见功能介绍。
2.5.2.项目说明栏
如图2-12,在项目历史版本说明栏中对各个项目的备注说明,当点击项目信息显示栏中条目信息时,对应保存的项目或项目文件的备注说明信息将显示在项目说明中,用户可以在此栏中重新编辑项目的备注信息并保存备注信息,用户可以使用说明栏的工具栏中的工具将项目的备注信息设置为用户喜欢的格式并保存格式信息。
2.5.3.需求与BUG显示栏
如图2-12,需求与BUG显示栏显示的是该版本的项目已经完成的需求与BUG信息。
用户可以填加和删除需求和BUG完成情况,具体操作见功能介绍。
2.6.状态栏
图2-13状态栏显示
如图2-19,状态栏显示出项目创建人、项目创建时间、项目路径信息和后台数据加载情况。
第三章功能介绍
3.
3.1.保存项目
保存项目的方法有四种:
1)点击菜单栏的文件菜单“导入项目”。
2)点击工具栏上的“导入项目”按钮。
3)在历史版本栏的右键菜单中选择“导入项目”。
4)在历史版本栏的右键菜单中选择“批量导入项目”。
3.1.1.导入项目
如图3-1,点击导入项目,进入【选择导入项目的文件夹】界面,从本地计算机,选择保存的项目文件,点击“确认”,导入项目。
图3-1导入项目
如图3-2,点击确定按钮后弹出窗口中点击保存填写版本说明和需求BUG完成情况后,点击保存来保存项目版本。
图3-2保存版本信息
3.1.2.批量导入项目
3.1.2.1.批量导入项目主界面
如图3-3,该界面由四部分组成:
1)目录栏:
复制项目路径,粘贴到此栏。
2)列表框:
将目录栏的内容导入并显示到左下方列表框中。
3)功能按钮:
执行具体操作。
4)完成导入的目录:
显示出完成导入的目录信息。
图3-3批量导入项目界面
如表3-1,有以下四大功能按钮
导入列表框
将目录栏的内容导入到列表框中
打开目录
打开列表框中的条目路径
导入选中行
导入列表框中选中的项目
开始批量导入
导入列表框中的全部项目
表3-1功能按钮
1.
2.
3.
3.1.
3.1.1.
3.1.2.
3.1.2.1.
3.1.2.2.批量导入项目的操作
如图3-3,打开本地计算机文件夹,选择一个项目,复制项目路径信息,将项目路径粘贴到目录栏,类此操作,将需要批量添加的项目路径都粘贴到目录栏,点击“导入列表框”按钮,将批量添加的项目导入项目列表中,同时,用户可以点击“打开目录”来确认要导入的项目是否正确,在确认无误后,用户可以选择“导入选中行”和“开始批量导入”来进行操作。
点击“导入选中行”和“开始批量导入”后的操作详见如图3-2及操作说明。
3.2.项目属性设置
如图3-4,文件菜单中点击项目属性(A)进入项目属性信息设置,设置完成后点击“保存”。
图3-4项目属性设置
3.3.项目栏中树节点的操作
如图表3-1,所有项目栏的右键菜单中,有以下四大功能属于对项目树的操作:
展开所有的节点
展开所有项目栏中所有树的节点
收缩所有的节点
收缩所有项目栏中所有树的节点
收缩其它节点
收缩所有项目栏中其他所有的节点
表3-1对项目树的操作
3.4.导入文件
3.4.1.导入文件的方法
导入文件的方法有三种:
1.点击菜单栏的文件菜单“导入文件”。
2.点击工具栏上的“导入文件”按钮。
3.在历史版本栏的右键菜单中选择“导入文件”。
3.4.2.导入文件的操作
如图3-5,点击“导入文件”,弹出文件选择对话框,用户可以选择计算机需要导入的文件,选择项目,点击“打开”按钮;进入【版本说明】界面,在左上方空白编辑栏中,填写版本说明信息,点击左上角“保存”按钮,成功导入文件。
图3-5导入文件
3.5.文件对比
文件对比,根据文件保存时间先后,分为以下五大类:
1.与最新版本对比。
2.与最老版本对比。
3.与其它历史版本对比。
4.与左侧当前版本对比。
5.文件三方对比。
图3-6与最新版本对比
3.5.1.与最新版本对比
如图3-6,点击当前项目的文件目录,点击工具栏的“与最新版本对比”或者右键菜单里的“与最新版本对比”,进入JSM软件对比合并软件,详细操作见JSM软件对比合并说明文档。
3.5.2.与最老版本对比
如图3-6,点击当前项目的文件目录,点击工具栏的“最老版本对比”或者右键菜单里的“与最老版本对比”,进入JSM软件对比合并软件,详细操作见JSM软件对比合并说明文档。
3.5.3.与其它历史版本对比
如图3-6,点击当前项目的文件目录,点击工具栏的“与其他历史版本对比”或者右键菜单里的“与其他历史版本对比”,进入JSM软件对比合并软件,详细操作见JSM软件对比合并说明文档。
3.5.4.与左侧当前版本对比
如图3-7,在历史版本中,点击右键菜单中的“与左侧当前版本对比”,进入JSM软件对比合并软件,详细操作见JSM软件对比合并说明文档。
图3-7版本对比合三分合并对比
3.5.5.文件三方对比
如图3-7,在历史版本中,点击右键菜单中的“文件三方对比”,进入JSM软件对比合并软件,详细操作见JSM软件文件三方对比合并说明文档。
3.6.保存文件
保存文件的方法有以下四种:
1.点击菜单栏的文件菜单“保存文件”。
2.点击工具栏上的“保存文件”按钮。
3.在当前路径栏的右键菜单中点击“保存文件”。
如图3-8,选择有新版本的文件,点击“保存文件”,进入【版本说明】界面,在该界面左上放空白框中为该文件新版本填写【版本说明】,点击左上角【保存】按钮,成功保存文件,该文件新版本会在主界面右侧的【历史版本】栏中显示出来。
图3-8填写文件版本说明
3.7.文件操作
3.7.1.查看所有文件
如图3-9,查看所有文件,打开系统中所有项目文件。
查看文件的方式操作:
1.在【当前项目路径】栏的右键菜单中,选择“查看所有文件”;
2.进入“查看所有项目”界面,在该界面【文件名】空白条框中,输入查询条件,符合查询条件的条目信息会在下面的方框中显示出来;
3.选择条目信息,双击,即可定位到该项目在主界面中的位置。
图3-9查看所有文件
1.
2.
3.
3.1.
3.2.
3.3.
3.4.
3.5.
3.6.
3.7.
3.7.1.
3.7.2.查看同名文件
查看同名文件的方法有两种:
1.在菜单栏“设置”菜单中,选择“查看所有同名的文件”;
2.在工具栏中,点击“查看同名”按钮。
3.同名文件,即文件名相同的文件,而不是相同文件。
如图3-10,在当前项目栏选择项目文件,当该项目存在同名文件的时候,进行查看同名文件操作,在主界面右侧的历史版本栏中,会将出左侧项目树中所有与该项目同名的文件信息显示出来。
图3-10查看同名文件
1.
2.
3.
3.1.
3.2.
3.3.
3.4.
3.5.
3.6.
3.7.
3.7.1.
3.7.2.
3.7.3.隐藏相同的文件
隐藏相同文件的方法有两种:
1.在菜单栏“设置”菜单中,选择“隐藏相同的文件”;
2.在工具栏中,点击“隐藏相同”按钮。
相同的文件在左侧的当前项目路径栏中的版本与右侧的历史版本栏中的版本的对比中,无需进行“对比”操作的文件系统将隐藏,隐藏相同文件后,在当前项目路径栏中,只显示需要进行“对比”操作的文件,便于用户操作。
3.7.4.查看删除的目录和文件
查看删除的目录和文件的方法:
在菜单栏“设置”菜单中,选择“查看删除的目录和文件”。
3.8.设置第三方对比工具
如图3-11,在菜单栏“设置”中,选择“设置第三方对比工具”按钮,进入该界面:
1.在工具名称中输入工具名称
2.点击“浏览”按钮,打开本地计算机中对比工具,选择对比工具的引用路径,点击“打开”按钮。
3.点击“保存”,成功设置第三方对比工具。
4.设置完成后,可以在对比选项中选择对比工具。
图3-11设置第三方对比工具
3.9.需求与BUG管理
进入需求与BUG管理界面的方法有三种:
1.在菜单栏中点击“需求管理”,进入“需求与BUG管理”界面。
2.在菜单栏中点击“BUG管理”,进入“需求与BUG管理”界面。
3.在右下方项目需求管理栏中,右键选择“填写需求,BUG完成情况”,进入“需求与BUG管理”界面。
3.9.1.界面介绍
如图3-12,用户点击菜单栏中的需求和BUG,进行需求管理与BUG管理时,系统进入的是同一个需求和BUG设置界面。
图3-12需求与BUG管理界面
如图3-12,主界面由五部分组成:
1.菜单栏
2.工具栏
3.需求和BUG列表栏
4.需求和BUG信息栏
5.关联项目栏
3.9.1.1.菜单栏
如图3-13,菜单栏由文件菜单、添加需求(R)、新增BUG、选项由四部分组成,其中文件菜单由两部分组成:
保存(Saveas)、退出(Exit),在选项菜单中设置对比工具,用户可以根据自己习惯添加,系统默认JSM软件对比合并工具。
图3-13需求与BUG管理菜单栏
如表3-2,菜单栏功能显示:
文件
保存(Saveas)
保存需求和BUG信息
退出(Exit)
退出需求和BUG系统
添加需求
添加需求(R)
进入添加需求界面
新增BUG
新增BUG
进入添加需求界面
选项
BeyondCompare
设置对比工具
Jsm对比
设置对比工具
表3-2菜单栏功能表
3.9.1.2.工具栏
如图3-14,工具栏由部分组成:
1.保存
2.添加需求
3.新增BUG
4.树状显示
5.以表格的方式显示
图3-14工具栏显示
如表3-2,工具栏有以下六大功能:
保存
保存需求与BUG详细信息
添加需求
进入添加需求界面
新增BUG
进入新增BUG界面
树状显示
需求与BUG显示方式
以表格的方式显示
显示需求
显示BUG
显示执行中的
显示待测试的
显示待确认的
显示完成的
显示不用处理的
表3-3工具栏功能表
3.9.1.3.需求和BUG栏
如图3-12,需求和BUG栏中显示所有的需求和BUG列表,其显示方式有树状显示和网格状显示,切换方式点击工具栏中的
或者
。
网格状显示可以根据需要进行筛选。
3.9.1.4.需求和BUG信息显示栏
如图3-12,需求和BUG信息显示栏中显示需求和BUG列表中条目具体信息,用户可以在此修改信息和设置格式,设置完成后保存即可。
3.9.1.5.关联项栏
如图3-12,关联项目栏中显示需求和BUG列表中条目完成后对应的具体项目。
3.9.2.功能介绍
3.9.2.1.添加需求
1.添加需求的方法
添加需求的方法有以下两种:
1)在菜单栏点击“添加需求”按钮,进入添加需求界面。
2)在工具栏点击“添加需求”按钮,进入添加需求界面。
2.添加需求界面显示
如图3-15,在添加需求界面输入需求基本信息,填写详细说明,点击“保存”,添加需求成功。
图3-15添加需求界面
3.9.2.2.新增BUG
1.新增BUG的方法
新增BUG的方法有以下两种:
1)在菜单栏点击“新增BUG”按钮,进入添加需求界面。
2)在工具栏点击“新增BUG”按钮,进入添加需求界面。
2.新增BUG界面
如图3-16,在新增BUG界面输入需求基本信息,填写详细说明,点击“保存”,新增BUG成功。
图3-16新增BUG界面
3.9.2.3.附加功能
1.删除节点
如图3-17,在需求与BUG显示栏中,选择需求或BUG,在该栏右键菜单中,选择“删除节点”操作,可以删除该条目。
图3-17删除节点
2.关联项目
在本地项目管理主界面选择项目,在右下方需求、BUG完成情况栏的右键菜单中,选择“填写需求,BUG完成情况”,进入需求与BUG界面,如图3-18,在需求与BUG列表栏中右键菜单选“添加为完成的项目”。
图3-18关联项目操作
3.10.标记
标记分为两种情况:
1.标记
2.取消标记
3.10.1.标记
如图3-19,在当前项目栏选择任意节点,在历史版本栏的右键菜单中,点击“标记”按钮,该项目图标由
变为
,标记成功。
图3-19标记操作
3.10.2.解除标记
如图3-20,在当前项目栏选择任意节点,在历史版本栏的右键菜单中,点击“取消标记”按钮,该项目图标由
变为
,取消标记成功。
图3-20解除标记
3.11.恢复出厂设置
如图3-21,在菜单栏“设置”菜单点击“恢复出厂设置”,系统将还原用户设置,恢复默认设置。
图3-21恢复出厂设置
3.12.放入开发目录,启用历史版本
如图3-22-1,在主界面上方的历史版本栏的右键菜单中,选择“放入开发目录,启用历史版本”功能,即恢复历史文件。
如图3-22-2,在弹出的【恢复文件】对画框中,系统提示是否恢复历史版本文件,点击“是”,操作成功,点击“否”,不恢复该历史文件,点击“取消”,放弃当前操作。
图3-22-1放入开发目录,启用历史版本
图3-22-2放入开发目录,启用历史版本
3.13.增量文件导出
如图3-23-1,在左侧【当前项目路径】栏,选择文件,在右侧【历史版本】栏中,显示出该文件的历史版本信息,选择一个历史版本,右键“增量文件导出”,将该文件全部导出到本地计算机文件夹,如图3-23-2,在弹出的【保存增量文件】对画框中,有5个文件需要保存,选择文件夹,将历史文件全部导出到该文件夹,点击“确认”弹出【保存成功】对话框,保存成功后,点击“确定”按钮,系统自动弹出该文件保存到的本地计算机文件夹路径。
图3-23-1增量文件导出
图3-23-1增量文件导出
3.14.退出
如图3-24,退出JSM软件代码管理系统,可以点击文件菜单中的退出或者关闭按钮。
图3-24退出JSM软件代码管理系统
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- JSMSoft 软件 代码 分布式 版本 控制系统 单机