【问题标题】:PHPDoc: How to hide private properties and methodsPHPDoc:如何隐藏私有属性和方法
【发布时间】:2014-01-26 20:29:12
【问题描述】:

文档只是显示了一个 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>,但似乎没有效果。

更新

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

【问题讨论】:

    标签: phpdoc


    【解决方案1】:

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

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

    【讨论】:

    • 显示所有 3 个按钮/部分,并且还列出了私有属性。
    • 必须是带有 --visibility 运行时标志的错误。我认为按钮可能无论如何都会在那里,但如果启用按钮,则不会显示任何代码元素。
    【解决方案2】:

    这对我有用--visibility="public"

    【讨论】:

      【解决方案3】:

      可见性元素有效。放在里面

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

      【讨论】:

        猜你喜欢
        • 1970-01-01
        • 2014-01-07
        • 1970-01-01
        • 2021-01-17
        • 2021-01-16
        • 2013-08-16
        • 2019-04-01
        • 1970-01-01
        • 2020-05-12
        相关资源
        最近更新 更多