Теги комментариев, которые должен освоить каждый PHP-пользователь

PHP

Введение

Ярлык аннотацииРоль комментариев кода очень велика, но многие студенты могут игнорировать роль этих меток в обычной разработке, поэтому я специально организую здесь некоторые часто используемые метки комментариев и показываю их в виде картинок и текстов, надеясь помочь вам понять лучше Роль каждого тега аннотации.

Может быть, вы в одной метке от красивого кода ^_^

Адрес проекта проекта : GitHub.com/Шин Гаочжэнь…

@deprecated

@deprecated: функция или метод-член, отмеченный этим, означает, что он будет объявлен устаревшим в следующей версии, и информирует соответствующую сторону о том, что этот метод больше не рекомендуется.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@deprecated [<version>] [<description>]

описывать

  • @deprecatedВы можете указать номер версии, правила для номеров версий такие же@version
  • Если отмеченный метод устарел только потому, что был заменен другим новым методом, вы можете комбинировать@seeдля представления замененного метода

эффект этикетки

demo.jpg

@inheritdoc

@inheritdoc: Наследование документа, наследует комментарии к документации родительского класса.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@inheritDoc

описывать

  • @inheritDocВсе комментарии к документации родительского класса будут унаследованы, указанные поля могут быть переписаны после наследования.

эффект этикетки

1. Прямое наследование

demo1.jpg

2. Переопределение наследования

demo2.jpg

@internal

@internal: внутренний класс/метод, помеченный этим тегом, может быть привязан только к текущему файлу и не может быть вызван из внешних файлов.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@internal [description]

сцены, которые будут использоваться

Этот тег обычно можно использовать в модульных тестах.Например, если тестовый класс определен в модульном тесте, вы можете добавить тестовый класс в этот тестовый класс.@internalМетки, чтобы, если другие случайно ссылаются на тестовый класс по ошибке в обычной логике, с помощью IDE они могли получить обратную связь в первый раз.

эффект этикетки

demo.jpg

@link

@link: Эта вкладка ведет к указанномуВнешняя ссылка для перехода.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@link [URI] [<description>]

описывать

Для этой вкладки есть только 1 вариант прыжка.

  • @外部跳转链接: должно быть удовлетвореноRFC2396переходить по ссылкам, напр.github.com/yinggaozhen

Отличие от @see

- @see @link
внешняя ссылка √ √
внутренняя процедура √ X

@see

@see: Эта вкладка ведет к указанномуВнешняя ссылка для перехода/внутренняя процедура.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@see [URI | FQSEN] [<description>]

описывать

Метка может иметь два варианта перехода

  • @外部跳转链接: должно быть удовлетвореноRFC2396переходить по ссылкам, напр.github.com/yinggaozhen
  • @内部程序链接: Вы можете перейти к указанному классу/методу/переменной, например class::method

Отличие от @link

- @see @link
внешняя ссылка √ √
внутренняя процедура √ X

@var

@var: определить тип данных.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@var [Type] [$element_name] [<description>]

список переменных

тип переменной инструкция
string нить
integer/int число/целый тип
boolean/bool false/true
float/double число/число
object экземпляр объекта
specifiedType указанный класс
mixed любой тип
array/specifiedType[] Массив, который может быть указан как массив указанного типа
resource тип файлового ресурса
void нет возвращаемого значения
null -
callable Исполняемая функция обратного вызова
function методы, которые не могут быть реализованы
self/$this текущий экземпляр

эффект этикетки

Реализация @var может использоваться двумя способами.

1. Определяются в переменных-членах класса, нет необходимости указывать имена переменных.

demo.jpg

2. Чтобы определить конкретную переменную напрямую, вам нужно указать имя переменной

demo.jpg

@throws

@throws: генерирует исключение, чтобы сообщить вызывающему объекту, что ему необходимо выполнить некоторую работу, связанную с обработкой исключения.

Подробная демонстрация кода:GitHub.com/Шин Гаочжэнь…

грамматика

@throws [Type] [<description>]

эффект этикетки

demo.jpg

Наконец

Длина статьи ограничена. Некоторые теги перечислены здесь. Доступ к другим тегам можно получить по следующим адресам проектов

Адрес проекта проекта : GitHub.com/Шин Гаочжэнь…

Ярлык будет время от времени обновляться, приветствую всехstar & fork

Ваша поддержка — самая большая мотивация для моего обновления~~

Категории