Теги автодокумента PHP Autodoc (Inheritance)

Question

Я использую phpautodocumentor, я пишу класс, который расширяет класс, который находится в совершенно другой папке. Как мне написать в комментариях, что я расширяю этот конкретный класс. Потому что intellisense в визуальной студии или Aptana не распознает. Код работает нормально. Проблема документирования. Это не говорит о том, что я так или иначе расширяю класс в документации

Answer 1

(с точки зрения phpDocumentor, docblocks в целом и всплывающей справки IDE ...)

В идеале среда IDE должна распознавать из кода, что текущий класс является дочерним по отношению к другому классу, и показывать вам информацию из родительского блока документации во всплывающей справке дочернего класса. Однако, если вы поместите докблок в сам дочерний класс и напишите в нем информацию, дублирующую разделы из родительского докблока (краткое описание, длинное описание, @param, @return), тогда информация о дочернем доклоке будет иногда «переопределять» родительскую информацию. , эффективно предотвращая показ всплывающих окон любой родительской информации.

Если я сделаю docblock для дочернего класса или унаследованных элементов, я буду использовать только теги в них, отличные от @param и @return, так что информация дочернего docblock дополняет родительскую информацию, а не заменяет ее. Однако, как правило, я не буду помещать докблок в унаследованные методы, так как он мне не нужен, чтобы показывать что-либо помимо того, что уже дано в докблоке родителя.

---

(с точки зрения "phpautodocumentor", о котором я не знаю, и Aptana, который я не использую, но предполагается, что он является производной Eclipse ...)

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

Вместо этого, если вы имеете в виду что-то, что генерирует фактическую документацию по классу отдельно от редактирования файла IDE, то, как правило, не требуется ничего, кроме самого кода. phpDocumentor, безусловно, распознает наследование классов только из кода и покажет унаследованные вещи в своем собственном разделе в большинстве выходных конвертеров. Если «phpautodocumentor» - это что-то еще, я не могу говорить о его возможностях.

Answer 2

Нет тега для расширения, ваша IDE должна понимать это из кода, хорошие - как PDT, Zend Studio или PhpStorm - делают. Тем не менее, есть тег @see для ссылки на другой контент в документах.

 /** 
  * this class extends main_class.
  * @see main_class, TEST_CONST
  */
  subclass extends main_class {
  }