Question

我发现在PHP中，如果我这样做：

class Foo{

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

doxygen不会记录成员函数'bar'

如果我取出'public'关键字，就可以了。是否有一些控制这个的设置？我已经在网上看到了这一点。

Answer 1

事实证明我运行的是错误的doxygen版本。在我的路上已经有了氧气，并指向1.3倍。现在一切正常。

Answer 2

因为它是一个类成员，所以你需要对类进行注释，以便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

希望有所帮助，祝你好运！

另一方面，将var类型列为上面提到的海报总是一个好主意（尤其是文档）。我通常将每个@param和@return声明为某种变量类型（因为我来自C ++背景），尽管在PHP中并不是完全必要的。在PHP中，您倾向于使用许多“混合”var类型，因为这在C ++中不会发生。无论如何，祝你的项目好运！

PHP中的Doxygen和Visibility关键字

2 个答案: