Java注釋是我們在編寫代碼時(shí)非常重要的一部分。通過合適地添加注釋,可以讓其他人更好地理解你的代碼,也可以讓你自己更好地理解和維護(hù)代碼。其中一個(gè)非常重要的信息就是作者名和時(shí)間。
/** * 該方法實(shí)現(xiàn)xxx功能 * 作者:張三 * 時(shí)間:2021/01/01 */ public void doSomething() { //具體實(shí)現(xiàn)代碼 }
在Java代碼中添加作者名和時(shí)間的注釋,一般都是在方法或者類的上方,用/**開頭,*/結(jié)尾,中間使用若干行的注釋。其中,作者名和時(shí)間需要放在@author和@author之后。
/** * 類名:Student * 描述:學(xué)生類 * 作者:李四 * 時(shí)間:2021/04/01 */ public class Student { //具體屬性和方法 }
在類的注釋中加上作者和時(shí)間,同樣也是在/**和*/之間添加注釋。需要注意的是,由于注釋是用于解釋代碼的,因此在注釋中要盡可能使用具體的描述,而不僅僅是作者名和時(shí)間。