如何使用PHP注釋記錄WordPress主題/插件的過濾器/操作

Question

我正在尋求有關如何為主題或插件之外的過濾器和操作生成文檔的建議。

作為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一個鏡頭，但它們更多地關注類，方法等。

有人知道當前的解決方案嗎？ 也許有人可以就如何處理類似情況分享一些見識。 我真的不想手動編寫文檔。

謝謝！

Answer 1

我個人說，只要您堅持，任何適合您的就足夠了。 PHPDoc應該是完美的。

撇開個人注釋-如果我們談論WordPress開發，那么它們的編碼標准定義得很好。

請轉到他們的文檔頁面，您可以找到有關他們如何記錄鈎子（動作和過濾器）的示例： https : //make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php /＃4-鈎子動作和過濾器