如何解决@link JavaDoc在一行和行长之间的Checkstyle冲突?

问题描述 投票:0回答:1

考虑以下JavaDoc:

  /**
   * Test method for
   * {@link MySelectionStyleConfiguration#configureSelectionStyle(org.eclipse.nebula.widgets.nattable.config.IConfigRegistry)}.
   * 
   */

[每当保存此注释所属的JUnit5测试类时,{@link }都会重新格式化为一行,这是正确的,否则,如果我尝试引入换行符,则Maven Checkstyle插件将引发错误。链接:(javadoc) SingleLineJavadoc: Javadoc comment at column 78 has parse error. Details: mismatched input '\n' expecting MEMBER while parsing REFERENCE。 (我也认为该链接在由此呈现的API文档中无法正确解析。)

但是,如果我将长链接行保留原样,则[M0 Checkstyle插件将[抛出错误:(sizes) LineLength: Line is longer than 100 characters (found 125).

有解决此问题的方法吗?

要求:

    100个字符行规则应保留不变,但应免除JavaDoc中的长{@link }标记(在测试类中最明显,但也许在其他地方也可以)。
  • 该链接仍应在呈现的JavaDoc中解析(即,该链接应保持有效)。

  • 编辑

    我可以从链接中省略程序包名称,但是我希望将它们保留在其中,以便它们仅解析为一件事,而不可能解析为同名事物。

  • hyperlink javadoc checkstyle maven-checkstyle-plugin
    1个回答
    0
    投票
    可以通过LineLength检查https://checkstyle.sourceforge.io/config_sizes.html#LineLength的“ ignorePattern”属性来完成>

    在您的情况下,类似

    <module name="LineLength"> <property name="max" value="100"/> <property name="ignorePattern" value="^ \* \{@link .*$"/> </module>

    将解决问题。
    最新问题
    © www.soinside.com 2019 - 2025. All rights reserved.