#php #wordpress #atom-editor #phpdoc
#php #wordpress #atom-редактор #phpdoc
Вопрос:
Я не могу поверить, что я не нашел уже заданный вопрос по этой теме (возможно, я ошибаюсь). Однако, например, в WordPress-Themes все 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) или в node-workflow или как-то иначе?
Ответ №1:
Добавление комментариев к заголовку обычно происходит автоматически.
Самый простой способ — настроить комментарий заголовка для каждого нового PHP-файла в вашей IDE. Например, в PhpStorm есть шаблоны файлов для этого.
Другим вариантом являются такие инструменты, как PHP CS Fixer. Вы настраиваете шаблон комментария заголовка и добавляете его во все файлы вашего проекта с помощью одной простой команды.
Такие инструменты, как PHP CS Fixer, — это лучший способ, потому что, если вы хотите что-то изменить в своем комментарии, вам просто нужно обновить шаблон в файле конфигурации и снова запустить консольную команду. Это обновит все файлы в вашем проекте.