Я полагаю, это зависит от того, почему вы хотите подчеркнуть, что метод влияет на этот защищенный атрибут...
Если вы просто хотите «сказать» это, просто укажите это в описании, с использованием или без использования встроенного тега @link:
/**
* Setter for $variables or {@link Test::$variables}
* ...
При использовании встроенной ссылки @ в описании метода создается гиперссылка на документацию $variables.
Вы можете использовать тег @see как отдельную ссылку на атрибут:
/**
* Setter
* @see Test::$variables
* ...
Это также создает гиперссылку на документ атрибута, но более заметен благодаря собственному тегу.
Если вы хотите создать «указатель» из метода на атрибут, используйте тег @uses:
/**
* Setter
* @uses Test::$variables
* ...
Тег @uses в методе здесь автоматически поместит тег @usedby в документацию для свойства $variables... результатом будет гиперссылка из метода на атрибут в документе метода, а также гиперссылка из атрибута к методу в документе атрибута. Думайте об этом как об аналоге «секретных проходов» в настольной игре Clue, которые соединяют угловые комнаты с противоположными угловыми комнатами.
Еще одно намерение, которое может быть выполнено с помощью тега @uses, заключается в том, что документация для $variables покажет список тегов @usedby, которые показывают все методы, влияющие на атрибут... при условии, конечно, что вы добросовестно поставили @ использует теги в этих методах.
person
ashnazg
schedule
02.09.2010