【问题标题】:IntelliJ: Cannot Add Custom JavaDoc TagsIntelliJ:无法添加自定义 JavaDoc 标记
【发布时间】:2017-11-19 21:20:12
【问题描述】:

有什么问题?

如何在生成的 JavaDoc 中将pre 定义为Precondition?比如支持的标签@param被翻译成

Parameters:
   .....

在生成的 JavaDoc 中。

【问题讨论】:

  • 您看到的错误是 javadoc 工具报告的,而不是 IntelliJ IDEA 报告的,因此任何 IntelliJ IDEA 设置都与此处无关。

标签: java intellij-idea javadoc documentation-generation


【解决方案1】:

我最终使用了一种解决方法:

/**
 * <pre>
 * "description here"
 * <b>Precondition:</b> "precondition here"
 * </pre>
 *
 * @param x  An integer.
 * other tags...
 */

自定义的“前提条件”标签应该以与生成的 JavaDoc 中其他支持的标签相同的格式打印出来。根据需要进行调整。

【讨论】:

    猜你喜欢
    • 2016-02-06
    • 1970-01-01
    • 2022-07-14
    • 2015-02-03
    • 2020-08-24
    • 1970-01-01
    • 1970-01-01
    • 2011-05-10
    • 1970-01-01
    相关资源
    最近更新 更多