java标头应该是javadoc还是多行注释?

时间:2018-04-04 16:38:03

标签: java comments javadoc multiline

第一个会在javadoc中使用/**

/**
 * Name: Raymo111
 * Date: April 4th, 2018
 * Description: Stack overflow question about headers
 */
public class whatever {

    //Some code here

}

第二个会在多行评论中使用/*

/*
 * Name: Raymo111
 * Date: April 4th, 2018
 * Description: Stack overflow question about headers
 */
public class whatever {

    //Some code here

}

1 个答案:

答案 0 :(得分:0)

如果您(或某人)希望从类中生成Javadoc(或保留它的可能性),您将需要使用Javadoc注释。如果你只是想无缘无故(或者真的讨厌类javadoc),请使用常规评论。

当然,如果您正在制作Javadoc评论,那么您应该在其中添加一些有用的内容。而不是名称,日期和描述,你将想要提供关于类的一些信息,如何使用它等。不是谁创建了类,什么时候,这是无关紧要的。