如何自动添加和更新文件头注释块？

Question

许多源文件在文档的开头都有一个突出的文件头。例如：

<?php
/**
 * Template for header
 *
 * Description
 *
 * @Author: Author
 * @Date: 2020-11-26 09:19:12
 * @Last Modified by:   Author
 * @Last Modified time: 2020-11-27 10:08:51
 *
 * @package WordPress
 */
?>

这些评论是如何添加的？我能想到的可能的解决方案是：

• 手册
• 编辑器中的片段/功能
• 其他插件

有人知道适用于大多数编辑器的解决方案吗？

Answer 1

添加标题注释通常是自动化过程。

最简单的方法是在 IDE 中为每个新 PHP 文件配置标头注释。例如，PhpStorm 有用于此目的的文件模板。

另一个选项是像 PHP CS Fixer 这样的工具。您可以使用一个简单的命令配置标题注释模板并将其添加到项目中的所有文件中。

像 PHP CS Fixer 这样的工具是一个更好的方法，因为如果你想更改评论中的某些内容，你只需要更新配置文件中的模板并再次运行控制台命令即可。它将更新您项目中的所有文件。