如何使用PHP评论文档WordPress主题/插件的过滤器/操作

时间:2018-06-08 23:40:53

标签: php wordpress wordpress-theming

我正在寻求一些有关如何为主题或插件分开的过滤器和操作生成文档的建议。

作为一名WordPress开发人员,通过我的项目中的PHP注释为这些自定义过滤器和操作生成文档会很有帮助。比方说如下:

/**
 * A short description.
 *
 * A summary.
 *
 * @since 1.0.0
 * @filter plugin_post_types
 */
$post_types = apply_filters('plugin_post_types', $post_types);

或类似的东西。

我尝试过给PHPDocumentor和ApiGen一个镜头,但他们更多地关注类,方法等。

有谁知道目前的解决方案?或者也许有人可以就他们如何处理类似情况分享一些见解。我真的宁愿不用手写文档大声笑。

谢谢!

1 个答案:

答案 0 :(得分:0)

就个人而言 - 只要你坚持下去,我会说任何适合你的东西都足够好。 PHPDoc应该是完美的。

暂时搁置个人信息 - 如果我们谈论WordPress开发,那么他们的编码标准定义得非常好。

请访问他们的文档页面,您可以找到他们希望如何记录钩子(操作和过滤器)的示例: https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#4-hooks-actions-and-filters