如何更新 Netbeans 方法前面的注释块？答案

【问题标题】：How to update comment block in front of methods in Netbeans?如何更新 Netbeans 方法前面的注释块？
【发布时间】：2010-10-25 07:05:51
【问题描述】：

我知道这不是编程相关的问题，但既然我们是程序员，我们可能会使用 Netbeans 进行 PHP 开发。

我想知道在更改参数集后如何在 Netbeans 中更新方法前面的注释块。我需要以某种方式自动更新它，并保留我之前添加的内容。

假设我在方法中添加了 10 个以上的参数，并且我希望它出现在之前的评论部分（PHPdoc），我该如何更新评论部分？

【问题讨论】：

【解决方案1】：

在 NetBeans 6.9.1 中，您可以键入。

/** /

然后按回车，它会为你生成带有参数的cmets。

【讨论】：

【解决方案2】：

您可以尝试在最后一个现有参数定义之后添加一个新行，然后点击自动完成键（通常是 ctrl-space）。例如：

/**
 * @var blah<new line here>
 */

然后

/**
 * @var blah
 * <ctrl-space>
 */

它可能为您填写...

【讨论】：

看起来你不会有任何运气。您可以尝试删除现有的 docblock（复制它）并让您的 IDE 重新生成它。您至少可以保留功能描述的副本。但是您需要重新描述每个参数等。

【解决方案3】：

如果我没看错，您希望在您编辑代码中的实际方法签名时有一些魔法可以调整您现有的文档块。如果任何 IDE 都可以做到这一点，我会感到非常惊讶。

我知道 Eclipse 可以自动填充一个新的文档块，您开始在已经编码的方法前面编写该文档块，自动显示 @param 标记，但这就是它的范围。对于 IDE 在您编辑代码时动态修改文档块，...我认为这会变得非常复杂。

我真的认为您必须手动编辑您的 docblock，添加新的 @param 标签以适应您修改过的方法。

【讨论】：

添加缺少的@param 标签/更改它们的类型应该不会太难，只要名称没有改变，或者你不介意丢失描述。它还可以将引用不存在的变量的任何 @param 标记突出显示为错误。