朙的學(xué)習(xí)筆記

        在代碼中加入注釋是非常好的編程習(xí)慣。
        在Java中提供了JavaDOC用于生成類、方法的說明文檔。可以通過該文檔輕松說明類、方法的作用、參數(shù)、返回等信息。

        JavaDOC的注釋規(guī)則如下：

        (1) 文檔注釋置于將要注釋的類或方法定義之前。

        (2) 專有注釋定界符/** 開頭。

        (3) 第一行描述該方法的目的。

        (4) 對每個參數(shù)進行注釋。每行以@param開始，此后是參數(shù)名和簡要說明。

        (5) 最后一行描述該方法的返回值。以@return開始。

        (6) 最后以*/結(jié)束。

        例如：

1/** *//**
2*    這個方法要完成……
3*    @param name 參數(shù)意義
4*    @return 最后要返回一個什么什么的
5*/
6

——摘自BIG JAVA

        當(dāng)然JavaDOC的功能還不止這些。
        @后面還有很多參數(shù)。等下次再研究研究。