是否可以在右侧创建文档注释而不是顶部?

时间:2015-05-21 05:01:24

标签: java documentation comments

文档有时会降低代码的可读性。

而不是

/**
 * The X axis.
 */
int x;

/**
 * The Y axis.
 */
int y;

/**
 * The Z axis.
 */
int z;

我宁愿选择

int x; /** The X axis */
int y; /** The Y axis */
int z; /** The Z axis */

Java中有没有办法在e的权利上发表评论。 G。变量声明?通过使用"<"我已经看到它在C中有效。性格,但尚未在Java中看到它。 Java已经在版本8中了,我想知道为什么它仍然不可能。或者是吗?

1 个答案:

答案 0 :(得分:1)

Doc Comments只能工作一次。它们可以在代码中的任何位置多次,但只有第一个由Javadoc工具提取。其余的很简单。