Git基础篇（十八）——给分支添加说明

前言：
  Git的一大有势是分支开发，当分支太多时光靠分支名已经难以记忆每个分支创建时的意图，为了解决此问题Git支持给分支添加说明。

1 给分支添加描述

1.1 给当前分支添加描述

  执行以下指令给当前分支添加描述信息。

1
git branch --edit-description

  执行该指令后，将在进入编辑模式（默认是Vim模式）编辑描述信息。

1.2 给指定分支添加描述信息

&emps; 可通过指定分支名的方式给特定分支添加描述信息，描述信息写在双引号内。

1
git config branch.<BranchName>.description "<Description>"

   <BranchName> 为指定的分支名， <Description> 为描述信息。
  也可以执行以下指令在编辑模式中给指定分支添加描述信息。

1
git branch --edit-description <BranchName>

2 查看分支描述信息

  给注释添加描述同时也是查看描述的方法。

2.1 查看当前分支描述信息

  执行以下指令在编辑模式中查看当前分支描述信息。

1
git branch --edit-description

2.2 查看指定分支描述信息

  执行以下指令查看特定分支的描述信息。

1
git config branch.<BranchName>.description

  也可以执行以下指令在编辑模式中查看指定分支描述信息。

1
git branch --edit-description <BranchName>

2.3 查看所有带描述分支的描述信息

  执行以下指令可以将所有带有描述信息的分支及其描述信息内容列出。

1
git config --get-regexp branch.*.description

3 分支描述只在本地

  需要注意的是，以上操作添加的分支描述只存在于本地，不会被推送到远程服务器中，当分支被删除时描述信息也被删除。