Java標頭應該是javadoc還是多行注釋？

Question

第一個將像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

}

Answer 1

如果您（或某人）想從該類生成Javadoc（或保留它的可能性），則需要使用Javadoc注釋。 如果只是無緣無故想與眾不同（或者真的討厭類javadoc），請使用常規注釋。

當然，如果要發表Javadoc注釋，則應在其中添加一些有用的內容。 除了名稱，日期和描述以外，您還需要提供有關該類，如何使用它的信息等。這與誰創建該類以及何時創建該類無關。