phpDocumentor 不喜欢文件级文档块中的@param和@return标签...
如果您选择一个单独的文件来记录它们，按照Mr-sk的回答，您可以使用@link指向那里，但它不会立即在文件的文档页面中可见......它只是您必须单击才能查看信息的超链接。如果您希望该文件的任何内容在脚本文件的文档页面上可见，您可以使用内联{@example}标记来指向它，甚至只是其中的某些行，例如{@example /path/ to/file 3 5}仅显示第三行到第五行。
在这种情况下，我可能会选择只在文件级文档块的长描述中解释内容，因为实际上没有直接的方法将参数标记到 phpDocumentor 无论如何都会将它们识别为代码元素的位置。如果我在描述中使用的任何参数确实是源自代码中其他位置的记录的代码元素，我将使用内联{@link}标记来指向该代码元素。
例如，假设在另一个代码文件中定义了一些常量，并且在解析该其他文件时会生成这些元素自己的文档。如果我在纯脚本文件（如您的文件）的文件级文档块中编写的长描述将这些常量作为参数，那么我的句子可能是：
If $POST['foo'] is set, its value should always be either {@link BAR_CONST} or {@link BAZ_CONST}.
参考：
| 归档时间： |
|
| 查看次数： |
2179 次 |
| 最近记录： |