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

【问题标题】：Good way to document controller actions in PHPDoc?在 PHPDoc 中记录控制器操作的好方法？
【发布时间】：2012-08-17 13:41:59
【问题描述】：

我正在尝试找出一种在 php mvc 框架中记录控制器操作的好方法。有一种方法可以将操作的 url 粘贴在其中，这对我来说非常重要，我的问题是我似乎无法找到一种方法将其放入 phpdoc 的架构中。

【问题讨论】：

【解决方案1】：

我不太了解您的问题/问题。您可以在 phpdoc 块中添加任何内容，包括控制器操作的相关 URL（如果需要，您甚至可以使用标记）：

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

也就是说，如果您特别想使用像 @url 这样的自定义标签，那么您只需要 use the -ct command-line option 告诉 phpdoc 您不希望它在遇到您的自定义标签时引发解析错误(s)：

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

【讨论】：

【解决方案2】：

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

我遇到了类似的问题并切换到doxygen。 Doxygen 允许您将自定义信息添加到您的 doc cmets，例如 @action_url，并且可以生成和输出 HTML、pdf、手册页等...

【讨论】：