Рубрики
Uncategorized

Теги аннотаций, которые должна освоить каждая статья

Автор оригинала: David Wong.

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

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

Адрес проекта : https://github.com/yinggaozhen/doc-demo/tree/master/ php

_

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

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/deprecated

@устаревший [<версия>] [<описание>]

  • @устаревший Вы можете заполнить номер версии по тем же правилам. @версия
  • Если от отмеченного метода отказаться просто потому, что он заменен другими новыми методами, его можно объединить. @см. Для представления замещенного метода.

_

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

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/inheritdoc

@inheritDoc

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

_

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

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/internal

@внутренний [описание]

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

_

@ссылка Этот тег может привести вас к указанной внешней ссылке перехода .

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/link

@ссылка [URI] [<описание>]

У тега есть только один вариант перехода

  • @ @ Внешняя перемычка Должна быть перемычкой, соответствующей RFC2396, например http://github.com/yinggaozhen
Внешние ссылки
Внутренние процедуры X

_

@см. Этот тег может привести вас к указанной внешней ссылке перехода / Внутренним процедурам .

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/see

@см. [URI | FQSEN] [<описание>]

Тег может иметь два варианта перехода

  • @ @ Внешняя перемычка Должна быть перемычкой, соответствующей RFC2396, например http://github.com/yinggaozhen
  • @ Внутренние ссылки программы Вы можете перейти к установленному классу/методу/переменной, например классу::метод
Внешние ссылки
Внутренние процедуры X

_

@var Определите тип данных.

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/var

@var [Тип] [$имя_элемента] [<описание>]

Символьная строка строка
Число/тип ввода целое число/int
ложь/истина логическое значение/bool
Число/С плавающей запятой поплавок/двойной
Экземпляр объекта объект
Указанный класс указанный тип
Любого типа смешанный
Массив, который может быть указан как массив указанного типа массив/указанный тип[]
Тип файлового ресурса ресурс
Нет возвращаемого значения пустота
нулевой
Выполняемая функция обратного вызова подлежащий выкупу
Метод, не обязательно подлежащий исполнению функция
Текущий экземпляр сам/$это

Существует два способа реализации @различных

_

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

Подробная демонстрация кода: https://github.com/yinggaozhen/doc-demo/tree/master/php/throws

@бросает [Тип] [<описание>]

_

Статья ограничена по объему. Вот несколько тегов. Дополнительные теги можно получить по следующим адресам проекта

Адрес проекта : https://github.com/yinggaozhen/doc-demo/tree/master/php

Этикетки будут постоянно обновляться время от времени. Добро пожаловать всем вам. звезда и вилка

Ваша поддержка-самая большая движущая сила для моего обновления.~~