Java 企業應用
          不要溫柔的走入那個良夜

            在使用Eclipse 編寫Java代碼時,自動生成的注釋信息都是按照預先設置好的格式生成的,例如其中author 的屬性值。

          我們可以在Eclipse 中進行設置自己希望顯示的信息。

                現在看看如何修改我們的用戶名即作者信息:點擊Windows->Preferences->Java->Code Style->Code Templates,

           

                     然后我們就可以選擇右邊窗口中的Comments,對應具體的comments選項,我們便可以對具體的注釋信息進行編輯設置。

          例如我們希望在一個Java文件的開頭設置作者作者信息以及日期信息。

                      選擇Types,點擊Edit,將

          /**
            * @author ${user}
          * ${tags}
          */  

          將${user}刪除,改成hanyankai,這樣作者信息就變成hanyankai;點擊Insert Variable,選擇Date,這樣就會自動生成日期信息。

                設置完以后我們測試一下,自動生成的注釋信息為:

          /**
          * @author hanyankai

          * 2009-11-27
          */

               同樣的步驟,我們也可以對其他例如構造函數等等注釋信息進行編輯設置。

              使用時鼠標放置在需要添加注釋的方法內部的任意位置。點擊菜單欄 中【源代碼】下的【添加 Javadoc 注釋】,或者使用快捷鍵 Alt Shift J ,則 eclipse 自動在該方法前面添加注釋。

          注釋的規范如下:

          文件注釋標簽:

          /**
          * <p>Title: ${file_name}</p>
          * <p>Description: </p>
          * <p>Copyright: Copyright (c) 2007</p>
          * <p>Company: LTGames</p>
          * @author linrz
          * @date ${date}
          * @version 1.0
          */

          類型注釋標簽(類的注釋):

          /**
          * <p>Title: ${type_name}</p>
          * <p>Description: </p>
          * <p>Company: LTGames</p>
          * @author    linrz
          * @date       ${date}
          */

          字段注釋標簽:

          /** ${field}*/

          構造函數標簽:

          /**
          * <p>Title: </p>
          * <p>Description: </p>
          * ${tags}
          */

          方法標簽:

          /**
          * <p>Title: ${enclosing_method}</p>
          * <p>Description: </p>
          * ${tags}
          */

          覆蓋方法標簽:

          /* (非 Javadoc)
          * <p>Title: ${enclosing_method}</p>
          * <p>Description: </p>
          * ${tags}
          * ${see_to_overridden}
          */

          代表方法標簽:

          /**
          * ${tags}
          * ${see_to_target}
          */

          getter方法標簽:

          /**
          * @return ${bare_field_name}
          */

          setter方法標簽:

          /**
          * @param ${param} 要設置的 ${bare_field_name}
          */

          posted on 2012-04-24 20:37 cpegtop 閱讀(22228) 評論(2)  編輯  收藏
          Comments

          只有注冊用戶登錄后才能發表評論。


          網站導航:
           
           
          主站蜘蛛池模板: 汤阴县| 行唐县| 广德县| 青田县| 海晏县| 且末县| 出国| 古田县| 喀喇| 台中县| 靖江市| 淄博市| 道孚县| 庆云县| 达日县| 二连浩特市| 吴堡县| 周至县| 太仓市| 苏州市| 新巴尔虎右旗| 沾益县| 贵港市| 江陵县| 临颍县| 建宁县| 苏尼特左旗| 正宁县| 屏边| 金阳县| 北宁市| 兴仁县| 阿尔山市| 正宁县| 杭锦旗| 光泽县| 黄平县| 宜兰市| 兴隆县| 克什克腾旗| 湘阴县|