git commit 如何添加注释

git commit 如何添加注释

在使用 git commit 时，可以通过以下几种方式为提交添加注释：

1. 使用 -m 参数添加单行注释

git commit -m "你的注释内容"

git commit -m "修复登录页面的样式问题"

2. 使用 -m 参数添加多行注释

git commit -m "第一行注释" -m "第二行注释"

git commit -m "修复登录页面的样式问题" -m "调整了按钮对齐方式和字体大小"

• 在提交记录中，第一行会作为标题，后面的内容会作为详细描述。

3. 不使用 -m 参数，进入编辑器编写注释

如果你不使用 -m 参数，直接运行 git commit，Git 会打开默认的文本编辑器（如 Vim 或 VS Code），你可以在里面编写多行注释：

git commit

• 编辑器打开后：
  • 第一行是简短的标题（建议 50 字以内）。
  • 第二行留空。
  • 第三行及以后可以写详细的描述。

示例：

修复登录页面样式问题

- 修复了按钮对齐问题
- 调整了字体大小
- 优化了响应式布局

4. 修改最近一次提交的注释

如果你已经提交了代码，但发现注释有误，可以通过以下命令修改最近一次提交的注释：

git commit --amend -m "新的注释内容"

git commit --amend -m "修复登录页面样式问题，优化了按钮对齐方式"

如果需要进入编辑器修改注释，可以直接运行：

git commit --amend

5. 提交注释的规范建议 ^{1 2 3}

注释参考: Conventional Commits

<类型>(<模块>): <简短描述>

[可选] 详细描述

常见类型：

• feat：新增功能
• fix：修复问题
• docs：文档更新
• style：代码格式（不影响功能）
• refactor：重构代码
• test：添加或修改测试
• chore：构建或辅助工具的变动

git commit -m "feat(auth): 添加用户登录功能"
git commit -m "fix(ui): 修复按钮点击无响应的问题"

参考: