在PHPDoc中记录控制器操作的好方法？

Question

我正在尝试找出一种在php mvc框架中记录控制器操作的好方法。对我来说非常重要的是，有一种方法可以将动作的URL粘贴在那里，我的问题是我似乎无法找到一种方法使其适合phpdoc的模式。

Answer 1

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

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

也就是说，如果您特别想使用@url之类的自定义标记，那么您只需要use the -ct command-line option告诉phpdoc您不希望它出现解析错误在您的自定义标记中：

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

Answer 2

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

我遇到了类似的问题并切换到了doxygen。 Doxygen允许您向@action_url等文档注释添加自定义信息，并且可以生成并输出HTML，pdf，手册页等...