Ключевые слова Doxygen и Visiblity в PHP - PullRequest
Новая
       6

Ключевые слова Doxygen и Visiblity в PHP

1 голос
/ 27 июля 2010

Я обнаружил, что в PHP, если я сделаю это: 

class Foo{

   /**
    * Does something cool
    * @return
    * Always returns 1
    */
      public function bar() {
        return 1;
      }
    }

doxygen не будет документировать функцию-член 'bar'

Если я выберу ключевое слово public, оноделает.Есть ли настройка, которая контролирует это?Я посмотрел онлайн и ничего не вижу по этому поводу.

Ответы [ 2 ]

2 голосов
/ 28 июля 2010

Оказывается, я использовал не ту версию doxygen. На моем пути уже был кислород, и он указывал на 1,3х. Теперь все работает.

0 голосов
/ 27 июля 2010

Поскольку это член класса, вам нужно также прокомментировать класс, чтобы doxygen знал, как искать в классе функции-члены. Сделайте что-то подобное перед классом Foo 

/**
 * @class Foo
 *
 * The foo class is awesome
 */

Вот код, который я использую (именно ваш плюс этот комментарий), который генерирует вывод по ссылке ниже. 

<?php

/**
 * @class Foo
 *
 * The foo class is awesome
 */
class Foo{

   /**
    * Does something cool
    * @return
    * Always returns 1
    */
      public function bar() {
        return 1;
      }
}

?>

http://raged.microsonic.org/test/html/classFoo.html

Надеюсь, это поможет, удачи!

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

...