@Package&@SubPackage：如何使用子主题

时间：2013-01-23 作者：Marie

我的问题是@package 和@subpackage.

我转到了建议的链接(What are the package and subpackage comment for?). 在那里，我没有找到任何可以应用于我的问题的方法，而是回答：“这些是PHPDoc标记，用于生成有意义的（自动的）代码文档”。这就是我现在拥有的：

/**

* Contains a list of all custom action hooks and corresponding functions defined for abc.

* This file is included in functions.php:

*

* @package theme-name

* @subpackage Functions

*/

这不是一个210岁的儿童主题。“主题名称”文件夹中有一个文件夹：functions. 我的子主题位于另一个文件夹中。我已经保存了functions.php 文件到我的子主题文件夹。更改子包我的文件夹名称或离开Functions 有消息。

我应该在这里放什么？

/**

* Contains a list of all custom action hooks and corresponding functions defined for abc.

* This file is included in functions.php:

*

* @package theme-name

* @subpackage ???

*/

4 个回复

SO网友:Chip Bennett

经验法则：您的代码是否与@package? 如果否，则使用的值不正确@package.

对于大多数主题来说，这很简单：

核心捆绑主题使用@package: WordPress 和@subpackage Theme-Name, 因为它们是用WordPress本身打包和分发的，所有其他主题都使用@package: Theme-Name, 因为它们是从WordPress单独打包和分发的@subpackage WordPress的。

我也会将这条规则应用于儿童主题。它们是一个独立的包，与它们所依赖的父/模板主题分别打包和分发。

SO网友:EAMann

正如您找到的原始文档所述，这些是phpDocument标记。它们根本不会影响您的代码，因此更改它们不会起任何作用。

然而，它们对于分析代码和创建可读文档的自动化工具很有用。This PHPXref 是WordPress解析版本的一个示例。

在WordPress中@package 通常是WordPress。这个@subpackage 是你正在看的任何模块。例如WP_Http 类包含：

/**
 * Simple and uniform HTTP request API.
 *
 * Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk
 * decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations.
 *
 * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
 *
 * @package WordPress
 * @subpackage HTTP
 * @since 2.7.0
 */

就你而言，@package 将是您主题的名称。@subpackage 是可选的，并且只有在主题中有其他模块时才真正相关functions.php 文件实际上不是主题的子包，因此在这种情况下我将省略标记。

子主题不必继承@package/@subpackage 他们父母的结构。使用对您的项目有意义的内容，因为实际上，这些评论和注释是专门帮助其他人理解您的项目结构的。

SO网友:bueltge

这个@package 指定要将类或函数分组并定义到的包，这也是WordPress的主题。A.@subpackage 是主题的子级，就像特定需求的功能或子主题，是一个子包。

phpdoc标记文档的小提示：http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

SO网友:s_ha_dum

这些是文档标签。为了编写代码文档，可以使用它们对相关的代码位进行分组。Wikipedia has a good chart 使用不同的标签。官方文件位于http://www.phpdoc.org/.

当我更改子包我的文件夹名称或保留“Functions”字样时，不会发生任何事情（更改内容）。

正当什么都没发生。这仅用于代码文档。在通过PHPDoc脚本运行代码之前，您不会注意到任何东西，该脚本将生成文档，但不会更改代码的工作方式。

使用@package 确定您的主题。使用@subpackage, 如果需要，可以在主题内对函数进行分组，比如说一个包含特定于主题的小部件或其他东西的文件。

What difference does it make including the @package annotation or not?

http://codex.wordpress.org/Inline_Documentation

结束

小码农CODE

@Package&@SubPackage：如何使用子主题

相关推荐