Question

我们在eclipse（zend studio）中使用这样的评论：

/**
 * @return array<ObjectXY>
 */
public function moo() {
  // returns array of objectxy
}

现在，如果我想使用方法moo，我写道：

$myobj->moo();

然后，如果我将鼠标悬停在moo上方，我会在评论框中显示以下内容：

@return array

数组之后的“ObjectXY”在哪里？为什么缺少？我可以在eclipse（zend studio）中配置它吗？

谢谢。

编辑：我在tipoverflow中看到尖括号内的字符串也不会显示。

Answer 1

这些评论（Javadoc样式）可以包含HTML内容。所以角度括号内的单词用于标记评论。

如果您希望输出本身包含这些括号，请使用@code表示法：

/**
 * @return {@code array<ObjectXY>}
 */

这自然用于真正显示代码片段（您的示例是一个）。评论的返回标记通常用于提供文本信息，例如

/**
 * @return an {@code array<ObjectXY>} containing ...
 */

更新，因为我的第一种方法略显错误。

当您使用Zend Studio IDE开发PHP应用程序时，此样式的注释不称为Javadoc，而是PHPDoc。

角度括号中的单词用于标记的说法仍然是正确的。但解决方案似乎是错误的。在Javadoc中，@code表示法是一个相对较新的表示法。之前<code>...</code>。不幸的是，仅此一项不会显示括号中的单词。它必须与<pre>...</pre>一起使用（或者您应该单独使用pre）。也许这有效：

/**
 * @return an <code><pre>array<ObjectXY></pre></code> containing ...
 */

为什么eclipse无法识别尖括号？

1 个答案: