有没有正确的方法向 git 别名添加注释？

Question

许多 git 别名都有非常短的缩写/首字母缩略词/TLA 和长且几乎难以理解的命令行。

有没有一种“正确”的方法可以在别名中添加尾随注释，以便我可以记住它的用途，或者我从哪里得到它？

这取决于它是通过

git config --global alias.<shrt> 'cmd' 

命令创建的还是直接编辑我的

.gitconfig

文件创建的，以及它是否是 shell

!

命令等

如果有一种“一刀切”的方法那就太好了。

Answer 1

配置文件有注释语法，请使用它。

Syntax

中

git help config

部分的前两句话：

   The syntax is fairly flexible and permissive; whitespaces are mostly ignored.
   The # and ; characters begin comments to the end of line, blank lines are ignored.

Answer 2

有没有一种“正确”的方法可以在别名中添加尾随注释，以便我可以记住它的用途，或者我从哪里得到它？

是的：

使用 Git 2.45（2024 年第 2 季度），第 15 批，“

git config

”^(man) 学习了

--comment=<message>

选项，可以在配置中同一行的

variable = value

之后立即留下评论文件。

请参阅提交 31399a6、提交 fbad334（2024 年 3 月 15 日），作者：Junio C Hamano (

gitster

)。
请参阅 Ralph Seichter (rseichter)

 的 

commit 42d5c03（2024 年 3 月 12 日）。
（由 Junio C Hamano --

gitster

-- 合并于 commit 3256584，2024 年 4 月 5 日）

config

：添加

--comment

选项来添加评论

^{签署人：Ralph Seichter}

引入了向使用

git-config

所做的修改添加注释的功能。
用法示例：

git config --comment "changed via script" \
  --add safe.directory /home/alice/repo.git

根据建议的补丁，产生的输出是：

[safe]
  directory = /home/alice/repo.git #changed via script
                                   ^^^^^^^^^^^^^^^^^^^

用户需要能够区分使用自动化创建的配置条目和人工创建的配置条目。
自动化可以添加包含指向所做更改的解释的 URL 的注释，避免用户询问为什么他们的配置文件被第三方更改。

该实现确保无条件地将

#

字符添加到所提供的注释字符串前面，并且注释文本作为后缀附加到同一文本行中更改的键值对。
多行注释（即
包含换行符的注释）被视为错误而被拒绝，导致 Git 退出而不进行更改。

评论针对的是使用寻呼机或编辑器检查或更改 Git 配置的人员。
评论不适合稍后由

git-config

^(man) 阅读或显示。

git config

现在包含在其 手册页中：

--comment <value>

将注释附加到新行或修改行。
'

#

' 字符将是 无条件地添加到该值之前。
该值不得包含 换行符（不允许多行注释）。