如何在 PHPDoc 中良好地记录控制器操作？

Question

我正在尝试找到一种在PHP MVC框架中记录控制器操作的好方法。对我来说，将操作的URL粘贴到其中非常重要，但我的问题是似乎无法将其适配到phpdoc的模式中。

- herbert.fitzgerald

Answer 1

我其实不太明白你的问题/提问。你可以在phpdoc块中放置任何想要的内容，包括控制器操作的相关URL（如果您想，甚至可以使用标记）：

/**
 * This is some foo action.
 *
 * URL: /foo/bar/baz
 */
public function fooAction(/* ... */) {
    // ...
}

话虽如此，如果您特别想使用像@url之类的自定义标签，那么您只需要使用-ct命令行选项告诉phpdoc，在遇到您的自定义标签时不要抛出解析错误：

# Will specify custom tag @url
phpdoc -ct url ...

- FtDRbwLXw6

Answer 2

解决方案取决于您用于生成文档的软件。

我曾有类似的问题，转而使用 doxygen。Doxygen 允许您向文档注释中添加自定义信息（如 @action_url），并可以生成 HTML、pdf、man 页面等输出。

- Oliver A.

---

我只研究了少量的doxygen资料。如果您能展示控制器动作的使用示例，这将对我非常有帮助。 - herbert.fitzgerald