Как добавить последнюю модифицированную версию для блока кода PHP, используя PHPDoc?
Я разрабатываю тему WP и комментирую свой код PHP с помощью PHPDoc. Я хотел бы добавить версии больших блоков кода, чтобы клиент знал, когда он будет обновлен.
Допустим, я выпускаю исходную версию 1.0.0, а затем обновляю некоторый код в версии 1.0.2. Как мне подтвердить, что код изменен? Будет ли это правильно:
/**
* Code block #1
*
* @since ThemeVersion 1.0.0
* @version 1.0.2
*/
Я не уверен, что это правильный способ использования @version, поскольку, с другой стороны, у меня есть еще один случай, когда другой блок кода не был изменен после обновления:
/**
* Code block #2
*
* @since ThemeVersion 1.0.2
* @version 1.0.0
*/
Так что не уверен, если это имеет смысл .. пожалуйста, дайте мне знать ваши мысли.
Спасибо.
Решение
Ваш вариант использования — разумное использование комбинации обоих тегов.
Таким образом, я ожидаю, что ваше использование в кодовом блоке № 1 будет означать:
- этот блок был создан в теме v1.0.0
- этот блок последний раз изменялся в теме v1.0.2
(обратите внимание, что текущая версия Theme, используемая потребителем, может быть v2.0.0, но эти значения тега все еще означают, что они означают — даже если это установлены Тема v2.0.0, этот кодовый блок # 1 был первоначально добавлен в v1.0.0 и последний раз изменялся в v1.0.2)
Теперь в вашем кодовом блоке № 2:
@since ThemeVersion 1.0.2должен сказать мне, что блок был впервые создан в теме v.1.0.2- но
@version 1.0.0говорит мне, что он был последний раз изменен v1.0.0 … но это не может быть правильно, потому что это не было даже в коде до v1.0.2.
(если вы установите оба значения тега в 1.0.0, это скажет мне: «Блок № 2 был создан в v1.0.0 и еще не был изменен).
Другие решения
Других решений пока нет …