[发明专利]基于Git仓库的多维度、多视角和可视化注解系统的实现方法

说明书

本发明公开了基于Git仓库的多维度、多视角和可视化注解系统的实现方法，首先提供多维度和多视角注解选取方式，接着提供注解内容可视化添加方式，将注解代码与注解内容一致性关系存储到数据库。当用户查看代码文件时，使用文件内容相等性分析与比较算法分析比较该文件在Git仓库中所有带有注解的历史版本，找到该文件的所有历史版本中的注解代码与注解内容之间的一致性关系，最后使用标记语言将上述一致性关系的注解进行可视化。本发明可以对Git仓库中的项目代码添加注解，该注解不但可以包含文字、图片和超链接，还可以跨越多个文件的多处代码进行整合注解，并在历史迭代版本中的同一位置进行可视化显示，具有多维度、多视角和可视化的功能。

技术领域

本发明属于互联网和软件工程领域，具体涉及一种基于Git仓库的多维度、多视角和可视化注解系统的实现方法。

背景技术

现实生活中，许多用户习惯用复制整个项目目录的方式来保存不同的版本，或许还会改名加上备份时间以示区别，简单易用。但是这种方式有时候会混淆所在的工作目录，一旦弄错文件丢了数据就没法撤销恢复。

为了解决这个问题，很久以前就开发了许多种本地版本控制系统，大多都是采用某种简单的数据库来记录文件的历次更新差异。为了解决让开发者在不同的系统上进行协同开发的问题，于是，集中化的版本控制系统(Centralized Version Control Systems，简称CVCS)应运而生。随着对系统功能的不断完善和为了解决集中式代码版本控制系统中央服务器的单点故障问题，现如今流行的分布式版本控制系统(Distributed VersionControl System，简称DVCS)面世了，像Git，Mercurial以及Darcs等。

Git是一个开源的分布式版本控制系统，可以有效、高速地处理从很小到非常大的项目版本管理。Git是Linus Torvalds为了帮助管理Linux内核开发而开发的一个开放源码的版本控制软件。每一个Git克隆都是一个完整的文件库，含有全部历史记录和修订追踪能力。其最大特色就是“分支”及“合并”操作快速、简便；支持离线工作，GIT是整个项目范围的原子提交，而且GIT中的每个工作树都包含一个具有完整项目历史的仓库。

Git保留了每次代码演化的全部历史记录，方便我们回退到历史版本查看我们需要的内容。虽然代码中已经有了功能注释和逻辑注释，但是在团队协作开发过程中，负责人在审核提交的代码的时候，可能需要在不改变源代码的情况下对部分代码添加一些注解，同时，开发者也可以对代码添加一些注解，这些注解可以包括大量文字的知识点解析、伪算法讲解和图片，还可以跨越多个文件的多处代码进行整合注解等。一方面可以作为审核人员的审核笔记，便于今后查阅，另一方面也可以作为提交者和审核者之间的一种交流方式，审核者提问，提交者修改或者回答，最后还可以作为其他用户快速熟悉代码功能逻辑的一个重要途径，可以防止开发人员流动过大，交接不方便和减少新加入的开发人员的阅读和学习时间的问题。目前，比较流行的GitHub或者GitLab代码托管平台本身没有提供这种注解内容多维度、多视角和可视化的功能，无法满足我们的需求。

发明内容

本发明的目的是通过设计并实现一种多维度、多视角和可视化的注解系统，可以对Git仓库中的项目代码添加注解，该注解不但可以包含文字、图片和超链接，还可以跨越多个文件的多处代码进行整合注解，并在历史迭代版本中的同一位置进行可视化显示，辅助开发者阅读学习代码。

为实现上述目的，本发明采用的技术方案为基于Git仓库的多维度、多视角和可视化注解系统的实现方法，包含以下步骤：

S1：提供多维度和多视角注解选取方式；

S2：提供多维度和多视角的注解内容可视化添加方式；

S3：将注解代码与注解内容一致性关系存储到数据库；