PHPDoc:如何隐藏私有属性和方法

时间:2014-01-26 20:29:12

标签: phpdoc

文档仅显示存在可见性的xml配置属性,但未显示如何使用它。 command line equivalent的文档显示:

–visibility[=”...”]
Provide a comma-separated list of visibility scopes to parse.

This parameter may be used to tell phpDocumentor to only parse public properties and methods, or public and protected.

我的文档中出现了私有属性,我想隐藏它们。我试过了<visibility>public</visibility>,但似乎没有效果。

更新

我目前正在使用默认模板。它都列出了私有方法,并在模板上显示“私有方法”部分。

3 个答案:

答案 0 :(得分:0)

如果--visibility标志不起作用,那一定是个bug。然后,即使文件生成执行仅在启用“公共”的情况下运行,某些输出模板也可能会显示三个可见性视图切换。

在您使用特定模板生成的结果文档中,您是否仍然看到所有三个可见性按钮显示?如果是这样,请启用private和protected按钮,然后查看是否有任何私有/受保护的属性/方法确实可见。可能是您只记录了公共事物,但仍然在视图中看到私有/受保护的切换按钮。

答案 1 :(得分:0)

这适用于我 - visibility =“public”

答案 2 :(得分:0)

可见元素有效。放在里面

 <parser>
    <visibility>public</visibility>
    <target>docs/api</target>
</parser>