【问题标题】:Android Studio JavaDocs do not generateAndroid Studio JavaDocs 不生成
【发布时间】:2016-10-31 11:58:20
【问题描述】:

我今天启动了 Android Studio (2.1.2),当尝试使用 /** + enter 添加块 cmets 时,它不会使用 params 和 return 语句生成整个块。

我不确定是什么原因造成的。

我尝试用谷歌搜索这个问题。但到目前为止,我无法使用现有的解决方案进行修复。

请帮我解决这个问题。

【问题讨论】:

  • this 有帮助吗?
  • 它现在可以正常工作,没有任何修复.. 奇怪.. 血腥工作室.. 不知道为什么.. 对不起伙计们.. 感谢@Sufian 的回复..

标签: android intellij-idea javadoc android-studio-2.1 block-comments


【解决方案1】:

这是 Android Studio 中的一个错误。

如果它是类中的最后一个方法,并且你在它下面有一些注释的块 cmets,那么你不能生成块 cmets。

类似这样的事情:

{
  ......

    // You can't do a /** + enter here;
    // it won't generate JavaDoc if you do.
    public ViewPager getViewPager() {
        return mViewPager;
    }

    //  /*
    //   * Inner classes, interfaces, enums
    //   */
}

在这种情况下,IDE 不会为 getViewPager() 生成块注释。

【讨论】:

  • /** autogenerate 仅适用于类构造函数和方法。将// 添加到/***/ 似乎有点多余。如果我的评论与段落一样长,我宁愿只使用/***/,如果是单行,我将只使用//
  • 抱歉,我的解释可能让您感到困惑。但是如果由于某种原因在类的末尾已经有一个注释块注释,那么自动块注释生成对类中的最后一个方法不起作用。
  • 为什么要在/** 上添加//?当您的方法没有参数时,基本上/** 无效。
  • 我也没有添加//,我只是在那里发表评论以进行解释。 :)
  • 啊,我明白了。由于您的 getViewPager() 根本没有参数,因此 /** 只会提供 @return ViewPager :)。
猜你喜欢
  • 2015-03-14
  • 2022-07-22
  • 2011-11-15
  • 2013-06-06
  • 1970-01-01
  • 2018-02-22
  • 1970-01-01
  • 1970-01-01
  • 2019-10-27
相关资源
最近更新 更多