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

Question

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

score 4 · Accepted Answer

我真的不明白你的问题/问题。您可以在 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 ...

score 0 · Accepted Answer

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

我有一个类似的问题并切换到doxygen。Doxygen 允许您将自定义信息添加到您的文档注释中，例如@action_url，并且可以生成和输出 HTML、pdf、手册页等...

2 回答 2