如何自定义生成的javadoc存根?

时间:2013-02-05 17:14:28

标签: netbeans javadoc

在Netbeans中,当您在方法上方键入/**时,它会生成一个javadoc存根:

/**
 * 
 * @param 
 * @return 
 */

如何自定义生成的文本?我想要一个自定义的javadoc存根,如:

/**  Author = {author}
 *  
 * My custom text  
 * 
 * @param 
 * @return 
 */

注意:这是在方法上,而不是使用类模板的类。

搜索字词: netbeans javadoc模板存根自定义自动完成

1 个答案:

答案 0 :(得分:4)

这不会取代/**的功能,但它会为您提供替代方案。

  • 进入Tools, Options
  • 点击Edit, Code Templates标签,
  • 从语言下拉菜单中,确保选中 Java
  • 点击New
  • 输入您选择的缩写(我使用jdt作为javadoc模板),
  • 点击OK
  • 在展开的文字下,输入您想要的javadoc评论。注意:一个令人讨厌的事情是,你必须在带有单词的行的末尾有一个额外的输入,否则它不会将下一个单词向下移动到下一行。

例如,如果你输入:

/**
 * @author
 * 
 * @param
 * @return
 */

它会输出:

/**
 * @author
 * 
 * @param @return
 */

但是如果你输入这个:

/**
 * @author
 * 
 * @param
 *
 * @return
 */

它会输出:

/**
 * @author
 * 
 * @param
 *
 * @return
 */
有点奇怪。无论如何,一旦你输入了,请查看扩展模板:按钮,看它是否在选项卡上设置或输入或其他。那部分是你的选择。但是,您要激活模板。点击OK

在您的文档中,转到您要插入预格式化评论的位置,而不是在/**中键入jdt,然后执行展开模板操作(标签,输入等)和您的评论将会出现。