php - 如何为方法和属性自定义 NetBeans PHP 自动 DocBlock？

Question

创建/**<enter>用于生成 DocBlock 的方法后。它自动填充该函数的@paramand @return。例子：

/**
 *
 * @param type $str
 * @return type 
 */
public function strlen($str){
    return strlen($str);
}

如何自定义正在生成的块，以便它也填写@author并在之后结束/**<enter>

/**
 *
 * @param type $str
 * @return type 
 * @author John Doe <john@doe.com>
 */
public function strlen($str){
    return strlen($str);
}

谢谢

score 5 · Accepted Answer

可能有更好的方法来做到这一点，但这是我使用的方法：在工具 > 选项 > 编辑器 > 代码模板下，有一些用于快速生成代码的预定义组合。7.0 中的默认模板之一是：

vdoc<tab>

这会生成一个伪文档块和变量定义。您可以替换它并添加新的扩展为您想要的任何文本，就像 vim 缩写一样。您可以在 Netbeans 文档站点上找到更多信息：

score 4 · Accepted Answer

我相信您正在寻找的答案会在这里找到：phpDocumentor Tutorial

我想你会想看看 --customtags 命令行开关。

所以最有可能的是，当您转到工具 -> 选项 -> “PHP” -> “PHPDoc”时，您可以将 --customtags 命令行开关添加到 PHPDoc 脚本行中。

我没有亲自尝试过，但我一直在尝试将 NetBeans 与 DocBlocks 和 PHPDocumentor 结合使用来“自动”创建大量可用文档，而不会对其他编码人员过于费力。;-)

这里有一个关于设置 NetBeans 以使用 PHPDocumentor 的精彩视频教程：使用 NetBeans IDE 7.0 生成 PHP 文档

score 3 · Accepted Answer

要启用正确的@author 标签自动补全，只需转到：工具->模板->PHP->PHP 类，按“设置”按钮并取消注释以 . 开头的行#user=。现在您可以编辑姓名和电子邮件，它们会传递给您的班级评论。

score 0 · Accepted Answer

来自各种来源的简短回答：不，您不能编辑可以为您添加它的模板。

创建宏：工具 -> 选项 -> 编辑器 -> 宏

例子：

Alt+W => insert-break "/**" insert-break

此宏有助于用左手添加 PHPDoc，使其更快。您可以使用此宏生成您希望生成的任何内容，然后将光标放在正确的位置，然后在评论末尾添加@author YOUR_NAME。

添加行：

user=YOUR NAME <email.prefix at domain.extension>

这会将@author 添加到所有新的类/接口定义中。

我希望这能帮到您！

4 回答 4