VPF::@see в phpDoc - Форум программистов

sharpshooter

Дата 18.12.2015, 15:50 (ссылка)

(нет голосов)

Загрузка ...

Новичок

Профиль
Группа: Участник
Сообщений: 17
Регистрация: 10.9.2009

Репутация: нет
Всего: нет

Привет.
Смотрю про формат @see и не пойму:
1) что означает следующий абзац:

Цитата

When defining a reference to another "Structural Elements" you can refer to a specific element by appending a double colon and providing the name of that element (also called the "FQSEN").

Где надо ставить :: ?

2) что означает следующий пример? (number_of() - метод, а :alias: ? )

Цитата

@see number_of() :alias:

3) Не пойму если указывать к другим классам, то можно не всегда полный путь а с учетом текущего namespace и имеющихся use(по правилам php)?

ksnk

Дата 18.12.2015, 16:28 (ссылка)

(нет голосов)

Загрузка ...

прохожий

Профиль
Группа: Комодератор
Сообщений: 6855
Регистрация: 13.4.2007
Где: СПб

Репутация: 96
Всего: 386

1 - это "пересказ своими словами" определения FQSEN (отмотать вниз пару экранов или поискать FQSEN броузером).

Вообще - DocType, изначально, попытка навести порядок в написании комментариев. Потом подтянулись идешные разработчики и накрутили формализм. Причем зачастую каждый свой собственный.
Интуитивно понятно, что :alias: - эта функция просто синоним number_of. А вот кто и почему это должен понимать, кроме программиста, непонятно.

--------------------

Человеку свойственно ошибаться, программисту свойственно ошибаться профессионально ! user posted image

0 Пользователей читают эту тему (0 Гостей и 0 Скрытых Пользователей)
0 Пользователей:
« Предыдущая тема \| PHP: Общие вопросы \| Следующая тема »