WordPress 插件继续文档:面向对象编程 II
在本系列的这一点上,我们已准备好通过记录我们的文件、类、函数、变量等来完善我们的插件。
虽然这是我们实际上必须完成插件的最后一步,但这并不是该系列的最后一篇文章,因为我们将继续研究面向对象编程中的一些高级主题。
但在此之前,让我们将我们在上一篇文章中学到的所有内容付诸实践,将我们的插件升级到 1.0 版本。
当然,与之前的所有文章一样,我建议您及时了解我们迄今为止介绍的所有内容,这样您不仅可以完全了解我们所做的工作在上一篇文章中,但我们实际上是如何达到本文讨论的最后一点的。
了解和审查了所有这些内容后,让我们开始记录每个文件。
记录插件
我们可以通过多种不同的方式来记录这个插件:
- 我们可以首先记录所有文件头,然后我们可以回来记录类,然后我们可以回来记录变量,然后我们可以记录函数。
- 我们可以一次记录每个文件,并对每个文件中包含的所有内容进行简短的讨论。
显然,该选项将为每个部分生成更多文档,但应该会导致一篇不那么乏味的文章,并且更容易理解整个插件的控制流程。
为此,我们将逐个文件地研究该插件,为我们拥有的每段代码引入文档,然后我们将讨论代码后面的任何感兴趣的点。
最后,我们将确保在文章末尾引用该插件的最终版本。话虽如此,让我们开始吧。
单个帖子元管理器
回想一下,启动插件的主文件是位于插件目录根目录中的 single-post-meta-manager.php 文件。
以下是该文件的完整文档版本。仔细阅读每条评论,不仅要注意其遵循的格式,还要注意其提供的内容。