有没有办法编写单行javadoc注释,就像在doxygen /**<*/

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

我想像以前在 doxygen 中那样注释一个变量,我想知道是否有一种方法可以在同一行中声明变量后对其进行注释。 (我以前从未使用过 javadoc =/ )。

所以代替:

enum Example1 {
    /** one something */
    ONE,
    /** this means other something */
    OTHER,
    /** the rest of them as a separate value, due to ISSUE-88 */
    NONE,
}

有人会:

enum Example {
    ONE, /// one something
    OTHER, /// this means other something
    NONE, /// the rest of them as a separate value, due to ISSUE-88
}

即每个项目一行而不是两行(根据标准格式指南,这会将 Javadoc 放入单独的行中)。

注意:我使用三斜杠作为虚构的“单行 javadoc”语法

javadoc
1个回答
20
投票

是的,您可以使用

/** comment */

© www.soinside.com 2019 - 2024. All rights reserved.