代码评论中的不同风格

时间:2016-07-09 10:53:26

标签: java comments

评论(至少在Eclipse中)你的代码有什么区别:

/**  
 * This is a comment  
 */  

和此:

/*  
 * This is a comment  
 */  

它以另一种颜色显示。

2 个答案:

答案 0 :(得分:3)

第一种语法:

/**
 * This is a comment  
 */

是用于文档的JavaDoc注释,由IDE和文档工具自动解析。

/*
 * This is a comment  
 */

只是一个普通的块注释,用于编写多行注释时使用。

// This is a comment

只是一个正常的单行评论。

请在此处查看JavaDoc Documentation

答案 1 :(得分:1)

第二个是注释,而第一个是有用的,如果为你的程序集生成了javaDoc。

第一条评论将显示为跟随它的方法的JAVADoc描述。

对于您的案例[第2个],您似乎有一个方法跟随评论有一个参数这个,其中的描述是