web-dev-qa-db-de.com

@package & @subpackage: Verwendung mit untergeordneten Themen

Mein Problem ist mit @package und @subpackage.

Ich ging zu dem vorgeschlagenen Link ( Was sind die Paket- und Unterpaketkommentare für? ). Dort habe ich nichts gefunden, was ich auf mein Problem anwenden könnte, sondern diese Antwort: "Dies sind PHPDoc-Tags - verwendet, um eine aussagekräftige (und automatisierte) Codedokumentation zu generieren." Das habe ich jetzt:

/**

* 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

*/

Dies ist kein Kinderthema von zehnundzwanzig. Es gibt einen Ordner im Themennamen-Ordner: functions. Mein untergeordnetes Thema befindet sich in einem anderen Ordner. Ich habe die functions.php-Datei in meinem untergeordneten Themenordner gespeichert. Es geschieht nichts (Ändern des Inhalts), entweder wenn ich den Namen meines Ordners im Unterpaket ändere oder das Wort Functions dort belasse.

Was soll ich hier eintragen?

/**

* 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 ???

*/
7
Marie

Genau wie in der Originaldokumentation angegeben, handelt es sich hierbei um PHPDocumenter-Tags. Sie wirken sich überhaupt nicht auf Ihren Code aus, sodass Änderungen nichts bewirken.

Sie sind jedoch nützlich für automatisierte Tools, mit denen Sie Ihren Code analysieren und eine für Menschen lesbare Dokumentation erstellen können. Dieses PHPXref ist ein Beispiel für eine geparste Version von WordPress.

In WordPress ist der @package normalerweise WordPress. Der @subpackage ist das Modul, nach dem Sie suchen. So enthält beispielsweise der obere Teil der Klasse WP_Http Folgendes:

/**
 * 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
 */

In Ihrem Fall wäre @package der Name Ihres Themas. @subpackage ist optional und nur dann wirklich relevant, wenn Sie andere Module in Ihrem Design haben - Ihre functions.php-Datei ist nicht wirklich ein Unterpaket des Designs, daher würde ich das Tag in diesem Fall weglassen.

Untergeordnete Themen müssen auch nicht die @package/@subpackage-Struktur ihrer Eltern erben. Verwenden Sie, was für Ihr Projekt sinnvoll ist, denn diese Kommentare und Notizen sollen anderen helfen, die Struktur Ihres Projekts zu verstehen.

3
EAMann

Faustregel: Ist Ihr Code mit dem durch @package angegebenen Code gebündelt (d. H. verpackt )? Wenn nein, verwenden Sie einen falschen Wert für @package.

Für die meisten Themen ist dies einfach:

  • Core-Bundled Themes verwenden @package: WordPress und @subpackage Theme-Name, da sie gepackt und verteilt sind mit WordPress selbst
  • Alle anderen Themes verwenden @package: Theme-Name, da sie separat von WordPress gepackt und verteilt werden.

Alle Themes sind eine Abstraktionsschicht von WordPress selbst und verlassen sich auf WordPress, um ausgegeben zu werden. Diese Abhängigkeit macht sie jedoch nicht zu einem @subpackage von WordPress.

Ich würde diese Regel auch auf untergeordnete Themen anwenden. Sie sind ein eigenständiges Paket, verpackt und verteilt getrennt vom übergeordneten/Vorlagen-Design, auf das sie sich verlassen.

3
Chip Bennett

Das @Paket spezifiziert ein Paket, um Klassen oder Funktionen zu gruppieren und definiert ein Thema für WordPress. Ein @ -Unterpaket ist dem Thema untergeordnet, wie eine Funktion für eine bestimmte Anforderung oder ein untergeordnetes Thema, ein Unterpaket.

kleiner hinweis zum doc von phpdoc tags: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

0
bueltge

Das sind Dokumentations-Tags. Sie verwenden sie, um verwandte Codebits für die Zwecke der Codedokumentation zu gruppieren. Wikipedia hat ein gutes Diagramm mit den verschiedenen verfügbaren Tags. Die offizielle Dokumentation finden Sie unter http://www.phpdoc.org/ .

Es geschieht nichts (Ändern des Inhalts), entweder wenn ich den Namen meines Ordners im Unterpaket ändere oder das Wort "Funktionen" dort belasse.

Recht. Nichts passiert. Dies ist nur zur Codedokumentation gedacht. Sie werden nichts bemerken, bis Sie Ihren Code über das PHPDoc-Skript ausführen, das die Dokumentation generiert, aber die Funktionsweise Ihres Codes nicht ändert.

Verwenden Sie @package, um Ihr Thema zu identifizieren. Verwenden Sie @subpackage, wenn Sie möchten, um Funktionen innerhalb des Themas zu gruppieren, z. B. eine Datei voller themenspezifischer Widgets oder ähnliches.

Welchen Unterschied macht es einschließlich der @ package Annotation oder nicht?

http://codex.wordpress.org/Inline_Documentation

0
s_ha_dum