PHP Doc @example示例

时间:2019-04-19 22:05:48

标签: php phpdoc phpdocumentor2

我打算将PHP文档与产品集成在一起,因为我打算允许用户更改插件中的各种内容。

到目前为止,我的目录中已经有phpdoc .phar,我可以解析html文件。但是我有两个问题:

1-我不知道如何正确使用@example标记,

这是我的代码:

/**
     * Creates a custom cron schedule.
     * @param array $schedules list of schedules
     * @example class-wcdpue-admin.php add_filter( 'wcdpue_custom_cron_schedule', 300 ); Creates a custom cron
     * @since    2.0.0
     */
    public function wcdpue_custom_cron_schedule( $schedules ){

        $schedules['wcdpue_cron'] = array(

            'interval' => apply_filters( 'wcdpue_custom_cron_schedule', 900 ),
            'display' => __( 'Every 15 Minutes' )

        );

        return $schedules;

    }

当我检查phpdoc时,它显示如下:

How it looks

我不确定为什么它说找不到该文件,但我找不到在线使用此标记的示例,我希望它在使用示例中显示一个小代码框。

2-如何解决找不到文件的问题?

类文件路径为oop/admin/class-wcdpue-admin.php,我尝试将doc块更改为:

/**
         * Creates a custom cron schedule.
         * @param array $schedules list of schedules
         * @example /admin/class-wcdpue-admin.php add_filter( 'wcdpue_custom_cron_schedule', 300 ); Creates a custom cron
         * @since    2.0.0
         */
        public function wcdpue_custom_cron_schedule( $schedules ){

            $schedules['wcdpue_cron'] = array(

                'interval' => apply_filters( 'wcdpue_custom_cron_schedule', 900 ),
                'display' => __( 'Every 15 Minutes' )

            );

            return $schedules;

        }

我正在运行的phpdoc命令为:php phpDocumentor.phar -d oop/ -t docs/api --sourcecode,如果有帮助,出于某种原因,由于某些原因,我也看不到来自渲染的phpdoc的源代码:

enter image description here

感谢您的帮助

0 个答案:

没有答案