如何为方法和属性自定义NetBeans PHP自动DocBlock?

时间:2011-05-07 17:32:00

标签: php netbeans documentation docblocks

创建方法后,我使用/**<enter>生成DocBlock。它会自动填充该功能的@param@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);
}

由于

4 个答案:

答案 0 :(得分:5)

可能有更好的方法可以做到这一点,但这就是我所使用的:在工具&gt;下选项&gt;编辑&gt;代码模板,有一些预定义的组合用于快速生成代码。 7.0中的默认模板之一是:

vdoc<tab>

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

http://netbeans.org/kb/docs/php/code-templates.html#using-templates

答案 1 :(得分:4)

我相信您正在寻找的答案可以在这里找到:phpDocumentor Tutorial

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

所以很有可能,当你去工具 - &gt;选项 - &gt; “PHP” - &gt; “PHPDoc”,您可以将--customtags命令行切换添加到PHPDoc脚本行中。

我个人没有尝试过这个,但我一直在尝试将NetBeans与DocBlocks和PHPDocumentor结合使用,以“自动”创建大量可用的文档而不会过于强烈其他编码员。 ; - )

有一个很好的视频教程,关于设置NetBeans以使用PHPDocumentor:Generating PHP Documentation With NetBeans IDE 7.0

答案 2 :(得分:3)

要启用正确的@author代码自动完成功能,只需转到:工具 - &gt;模板 - &gt; PHP-&gt; PHP类,按&#34;设置&#34;按钮并取消注释以#user=开头的行。 现在,您可以编辑名称和电子邮件,并将其传递给您的班级评论。

答案 3 :(得分:0)

各种来源的简短回答:不,你不能编辑可以为你添加它的模板。

  1. 如果您仍在寻找相同的功能,可以创建一个,然后将其绑定到快捷方式(例如“Alt + W”)。
  2. 创建:工具 - &gt;选项 - &gt;编辑 - &gt;宏

    示例:

    Array#diffence

    这个宏有助于用左手添加PHPDoc,这使得它更快。您可以使用此宏生成您想要生成的任何内容,然后将光标放在正确的位置,然后在评论的末尾添加@author YOUR_NAME。

    1. 您还可以转到:工具 - &gt;设置项目的一般作者。模板;点击“设置”
    2. 添加以下行:

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

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

      我希望这会对你有所帮助!