是否有一个工具可以自动插入和更新 shell 或 Python 脚本等脚本头块？

Question

我发现了一位前管理员编写的脚本，他使用 Bash 或 Python 编写了相当不错的脚本。他的所有脚本都格式良好，并配备了看起来总是相似的“脚本标题”或“代码标题”，我称之为。

我想知道他是如何做到这一点的，是否有一个众所周知的工具可以插入并自动更新这些类型的“代码头”。

有什么想法/提示吗？

这是此类代码头块的示例。这不仅仅是Python。在许多语言和 Linux 脚本中都可以找到它：

#!/usr/bin/env python
# vim:fileencoding=utf-8
#
#   project-name
#   ~~~~~~~~~~~~~~
#
#   script description
#
#   * Intended to be run as a cron job.
#
#   Project title:      Back-Up Management
#
#   Project directory:  FileHost/project-name
#
#   Project documents:  xxxxx
#                       yyyyy
#                       zzzzz
#
#   Target OS:          Unix
#
#   Target interpreter: Python 2.5
#
#   File encoding:      UTF-8
#
#   2010-11-23  adminName     Created
#
#   2015-06-12  AdminName     CHANGE: some description
#
#   $Id: script-name.py 474 2010-12-10 12:16:36Z adminName $
#

Answer 1

从最后一行文字开始：

$Id: script-name.py 474 2010-12-10 12:16:36Z adminName $

你可以假设这些文件保存在 Subversion 中（有$Id$关键字的解释这里）。旧的 CVS 也会使用关键字$Id$，但这会将文件名扩展为script-name.py,v（就像完成的那样）这里）。

之前的两个条目可能来自修订历史提交注释，尽管它们看起来像标题的其余部分一样是手工制作的。

Project title:我会在机器上搜索 bash/python 文件，该文件具有类似于未注释掉的行上的字符串 。前管理员很有可能把他的“工具”留在了系统的某个地方。