Vscode +GitLens实现代码的Review

2,820 阅读4分钟

GitLens 是一款强大的 VSCode 插件,虽然它本身没有直接衡量代码质量的功能,但可以通过其提供的代码提交历史、修改记录等信息,从侧面辅助评估指定开发人员的代码质量,以下是具体的操作步骤和分析思路:

1. 安装和配置 GitLens

  • 安装:打开 VSCode,点击左侧活动栏中的扩展图标(四个方块),在搜索框输入 “GitLens”,选择对应的插件并点击“安装”按钮。

  • 配置:通常安装完成后即可使用默认配置。若有特殊需求,可以在 VSCode 的设置中搜索 “GitLens” 进行个性化配置。

2. 筛选指定开发人员的提交记录

  • 全局提交记录筛选

    • 打开 VSCode 的命令面板(快捷键:Ctrl + Shift + PCmd + Shift + P)。

    • 输入 “GitLens: Show All Commits” 并回车,打开全局提交记录视图。

    • 在提交记录视图的搜索框中,输入 “author:指定开发人员姓名或邮箱”,即可筛选出该开发人员的所有提交记录。

  • 文件提交记录筛选

    • 打开具体文件,在编辑器中右键点击,选择 “GitLens: Show File History”。

    • 在文件历史记录视图的搜索框中,同样输入 “author:指定开发人员姓名或邮箱”,筛选出该开发人员对该文件的提交记录。

3. 从提交记录评估代码质量

  • 提交频率和规模

    • 高频小提交:如果开发人员频繁进行小规模的提交,每次只修改少量代码,这可能表明其具有良好的编码习惯,注重代码的阶段性完成和及时保存,便于版本控制和问题追溯。

    • 低频大提交:若提交频率较低,但每次提交修改的代码量很大,可能意味着开发人员在进行大规模的功能开发,但也可能增加代码冲突和引入 bug 的风险。

  • 提交信息质量

    • 清晰详细:好的提交信息应该清晰描述本次提交所做的修改和目的。例如,“修复登录页面的密码验证漏洞” 比 “修改代码” 更能让其他开发者快速了解提交内容。

    • 前后一致:提交信息的风格和格式应该保持一致,便于团队成员理解和维护。

  • 代码修改内容

    • 查看变更详情:在提交记录视图中,点击具体的提交记录,可以查看该提交所做的代码修改详情。注意观察代码的新增、删除和修改部分。

    • 代码规范遵循情况:检查代码是否遵循团队的代码规范,如命名规范、代码缩进、注释等。不规范的代码可能会影响代码的可读性和可维护性。

    • 功能完整性和正确性:分析代码修改是否完整地实现了预期的功能,是否存在逻辑错误或潜在的 bug。可以结合代码的上下文和业务需求进行判断。

4. 使用 GitLens 的其他功能辅助评估

  • Blame 功能

    • 将鼠标悬停在代码行上,GitLens 会显示该行代码最后一次提交的作者、时间和提交信息。通过查看代码的每一行是谁编写的,可以了解开发人员对代码的具体贡献和修改情况。

    • 对于有问题的代码行,可以通过 Blame 功能快速定位到责任人,进一步分析其编码质量。

  • 文件历史对比

    • 使用 “GitLens: Compare File with Branch/Commit” 功能,对比指定开发人员不同提交版本之间的代码差异。可以更直观地看到代码的演变过程,评估其在不同阶段的编码质量和改进情况。

或者在vscode里执行git log --author="成员名字" --before="2023-12-31" --no-merges --numstat --pretty="%H" 会列出提交的非merge代码,点击可直接查看代码的更改内容。