2011-05-07 64 views
33

创建方法后,我使用/**<enter>来生成DocBlock。它会自动填充该功能的@param@return。正在生成如何为方法和属性自定义NetBeans PHP自动DocBlock?

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

我如何自定义模块,以便它也是在@author填充后这样结束了/**<enter>

/** 
* 
* @param type $str 
* @return type 
* @author John Doe <[email protected]> 
*/ 
public function strlen($str){ 
    return strlen($str); 
} 

感谢

+0

我还没有看到这方面的任何选项,你也不能手动添加它与代码模板,因为他们不会在评论中工作。我有兴趣了解是否有任何方法可以做到这一点。 – Fanis 2011-05-07 23:27:22

+6

我不知道,但**但你可以,同时,使用宏来做到这一点。 docblocking类时,我拥有'@ copyright'和'@ author'宏。我还建议'@作者'的课程,而不是每个单独的方法。 – ShotgunToothpaste 2011-05-08 01:15:48

+0

@ Shadower856我甚至没有注意到2年使用netbeans的宏功能!我一直在使用代码模板,但那些代码区域之外不会工作..伟大的提示 – Fanis 2011-05-08 10:28:23

回答

5

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

vdoc<tab> 

这会生成伪docblock和变量定义。你可以替换它并添加新的扩展到你想要的任何文本,就像vim的缩写。你可以找到更多关于这个在NetBeans文档站点:

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

4

我相信你正在寻找的答案将在这里找到:phpDocumentor Tutorial

我想你会想看看--customtags命令行开关。所以最有可能的是,当你去工具 - >选项 - >“PHP” - >“PHPDoc”时,可以将--customtags命令行开关添加到PHPDoc脚本行中。

我没有亲自尝试这一点,但我一直在使用NetBeans与文档块和phpDocumentor的组合而不上休息太费劲“自动地”创建可用的文件一个良好的数额的想法打转转的编码器。 ;-)

有关于设置的NetBeans与这里提供的phpDocumentor工作一个很好的视频教程:Generating PHP Documentation With NetBeans IDE 7.0

3

为了能够正确@author标签自动完成,只要进入:工具 - >模板 - > PHP-> PHP类,按下“设置”按钮,并取消以#user=开头的行注释。 现在您可以编辑传递给您的课程评论的名称和电子邮件。

+0

这适用于有用的类,但不适用于OP要求的功能doc块 – icc97 2014-09-23 12:08:02

0

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

  1. 如果你还在寻找一个功能一样,你可以创建一个做,然后将其绑定到一个快捷键(“Alt + W”的实例)。

要创建:工具 - >选项 - >编辑 - >宏

例子:

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

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


  • 您还可以通过将设置你的项目的总作者:工具 - >模板;点击 “设置”
  • 添加一行:

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

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

    我希望这会帮助你!