web-dev-qa-db-de.com

Warum wird von der Verwendung des @uses-Tags in Dokumentenblöcken abgeraten?

Siehe Inline-Dokumentationsstandards

Hinweis: Dieses Tag wurde in der Vergangenheit verwendet, sollte aber nicht mehr verwendet werden.

Was gibt?

Ich baue ein Plugin, um einen Codex aus der Quelle eines Plugins/Themas zu erstellen, und ich denke, das Tag @uses wäre perfekt, um Funktionen mit Hooks und Hooks mit Funktionen zu verknüpfen.

6

Ich bin mir nicht 100% sicher, aber ich denke, es liegt daran, dass die Verwendung von @uses mit @see abgedeckt werden kann.

Aus phpDocumentor-Dokumenten

@uses ist @see sehr ähnlich. Einzelheiten zu Format und Struktur finden Sie in der Dokumentation zu @see. Das Tag @uses unterscheidet sich in zweierlei Hinsicht von @see. @see ist ein Einweg-Link, dh die Dokumentation, die ein @see-Tag enthält, enthält einen Link zu anderen Dokumentationen. Das Tag @uses erstellt automatisch ein virtuelles Tag @usedby in der anderen Dokumentation, das mit der Dokumentation verknüpft ist, die das Tag @uses enthält. Mit anderen Worten, es ist genau wie @see, außer dass ein Rücklink automatisch hinzugefügt wird.

Der andere Unterschied ist, dass @uses nur ein Element zum Verknüpfen und eine Beschreibung dieses Elements akzeptiert.

Wahrscheinlich haben WP Leute entschieden, dass es sich nicht lohnt, 2 Tags so ähnlich zu haben, sondern nur eines beizubehalten.

Übrigens, @uses ist ein feines Etikett. Wenn Sie es unterstützen möchten, tun Sie es einfach und dokumentieren Sie seine Unterstützung in der Dokumentation.

5
gmazzap