Java中的内联注释:/**与/*?
我之所以喜欢用java编写内联注释,原因如下:Java中的内联注释:/**与/*?,java,eclipse,comments,javadoc,Java,Eclipse,Comments,Javadoc,我之所以喜欢用java编写内联注释,原因如下: /** Init operation */ mindControlLaser.engage(); 与仅使用一个*相反: /* i'm a happy comment */ Eclipse给语法添加了不同的颜色,但是“工具链”(javadoc、Eclipse等)中真的有什么东西让我在使用/***/?是的,使用/**主句是javadoc符号。其他描述*/。之前的第一个句子将在javadoc摘要中使用,其余部分将在详细视图中使用。/**表示“文档”注
/** Init operation */
mindControlLaser.engage();
与仅使用一个*相反:
/* i'm a happy comment */
Eclipse给语法添加了不同的颜色,但是“工具链”(javadoc、Eclipse等)中真的有什么东西让我在使用/***/?是的,使用
/**主句是javadoc符号。其他描述*/代码>。
之前的第一个句子将在javadoc摘要中使用,其余部分将在详细视图中使用。/**
表示“文档”注释;Javadocs等。在为代码创建文档时查找这些文档
因此,它们实际上应该仅用于上述方法和类,例如:
/**
* Class to represent tigers.
*/
class Tiger {
/**
* Go extinct.
*/
void goExtinct() {
}
}
/*
变量仅表示标准注释块。注释的语法为/**/
Javadoc默认使用/***/
。这是一条注释,因为第二条*
在注释内,因此编译器不会看到不同的内容
因此,如果没有第二个注释,您只需添加一条注释,使用第二个注释,您就可以编写javadoc:eclipse将在其他地方悬停函数调用时识别它并给您提示等;上面有/**注释的类和方法将被放入javadoc输出。不需要内联注释
/**
向javadoc实用程序发送信号,自动提取有关API的文档。当在方法内部使用时,它没有任何效果。/***/代码>将生成Javadoc,/**/代码>不会
当然,它只会在正确的位置生成Javadoc。Javadoc还有一个定义良好的格式,请参见。常规注释
/*常规注释*/
通过定期的评论,你可能会解释一个复杂算法的一部分。
或者任何你不想成为JavaDOC一部分的东西。内联注释也是常规注释,可以在描述较短时使用
Java文档
/**JAVA文档注释*/
使用javadoc可以解释类、方法或字段(变量)
然后,像Eclipse这样的大多数IDE可以在编写代码时使用这些信息来帮助您。
例如,如果您有一个classA
和一个classB
,并且在classB
中使用classA
中的内容,那么如果您将鼠标悬停在方法或变量上,您可以看到JavaDOC信息。它很方便
此外,使用像ant
这样的构建工具,您可以自动从JavaDOC构建HTML文件,如果您发布它们,您可以允许其他人重用您的工作。
例如,查看Java本身的文档