在源文件中自动添加/更新注释头块答案

【问题标题】：Automatic add / update comment header block in source files在源文件中自动添加/更新注释头块
【发布时间】：2021-03-10 02:35:14
【问题描述】：

我不敢相信我没有找到关于该主题的已被问到的问题（也许我错了）。但是，例如在 WordPress 主题中，所有 PHP 文件都带有一个注释标题块：

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

添加和维护这些评论块的最佳做法是什么？它是直接在文本编辑器（atom）中完成还是在节点工作流中完成？

【问题讨论】：

标签： php wordpress atom-editor phpdoc

【解决方案1】：

添加标头 cmets 通常是自动化过程。

最简单的方法是在 IDE 中为每个新的 PHP 文件配置标题注释。例如，PhpStorm 对此有 File templates。

另一种选择是像PHP CS Fixer 这样的工具。您配置header comment 模板并使用一个简单的命令将其添加到项目中的所有文件中。

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

【讨论】：